Skip to content
This repository has been archived by the owner on Sep 13, 2024. It is now read-only.

standardize syntax in GET demonstrations when that matches standardization in api.rackspace.com #109

Open
rose-coste opened this issue May 12, 2015 · 3 comments

Comments

@rose-coste
Copy link
Contributor

API requests asking different services to do similar things are shaped more similarly in reality than they appear to be if you compare API documentation for several services. If you want any Rackspace API to return a list of things, sending to its endpoint something shaped like "GET /release/tenant/things" is consistently a good guess as to how to ask for that list, though you might doubt that consistency based on what's described for each of the four core infrastructure services in its WADL as published in its Developer Guide and especially at api.rackspace.com:

The apparent inconsistencies will be reconciled as we develop and implement standards for how API operations are described in WADLs and then republish based on those standardized WADLs. Noting the issue here as a reminder to watch for change in what's published at api.rackspace.com and update each product's SDK+API introduction (text and screenshots) to match when change occurs.

Pages to update are:

@rose-coste rose-coste self-assigned this May 12, 2015
@rose-coste rose-coste changed the title standardize syntax of GET when that matches standardization in api.rackspace.com standardize syntax in GET demonstrations when that matches standardization in api.rackspace.com May 12, 2015
@rose-coste rose-coste added this to the WADL standardization milestone May 14, 2015
@rose-coste
Copy link
Contributor Author

DevDoc team is developing a new standard now; will take a little longer to define the standard, then republish the API doc implementing the standard, then revise API doc in this guide to match the API doc

@rose-coste
Copy link
Contributor Author

updating link to published draft, changed by #225

@stephamon
Copy link

talk to Cat about this one

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants