openstorage
openstorage copied to clipboard
trailing / in API specification should be removed
I like to fix the API specification for following functionalities in http://api.openstorage.org. All of them have trailing / after {uuid} as {uuid}/.
- Delete Volume
- Inspect Volume
- Change Volume state
- Retrieve Volume *
In general most REST services
There are few good examples describing why trailing slash confuses and should be avoided while describing a specific resource. (1) http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#restful (2) Applied Web Services section in https://en.wikipedia.org/wiki/Representational_state_transfer#Example (3) https://softwareengineering.stackexchange.com/questions/186959/trailing-slash-in-restful-api
Who are the author of the http://api.openstorage.org? As this is more of documentation bug, I like to contact the author(s).
Thanks @paravmellanox for pointing this out. The best would be to submit a PR against https://github.com/libopenstorage/specs/blob/master/api/openstorage.yaml. ping @brianhama
@pault84 pls follow up on this.