04de167e379bc47ea1bff07c98f0dd785cf328f3
Commit Graph

8 Commits

Author SHA1 Message Date
Sergey Nikitin
5417d83ec3 api-ref: added docs for microversion 2.26
Part of bp:tag-instances
Part of bp:api-ref-in-rst
Change-Id: Ifd0d518d086719eb248b442359c272b1799544c6
2016年06月23日 23:42:39 +03:00
ghanshyam
40ea165e81 Publish proxy APIs deprecation in api ref doc
As first step to deprecate the proxy APIs,
this commit publish the deprecation of proxy APIs
in api ref doc.
Partially implements blueprint deprecate-api-proxies
Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
2016年06月14日 15:31:18 +09:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016年06月03日 08:47:33 -04:00
Sean Dague
36c688f694 api-ref: finish validation for os-server-external-events.inc
This completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.
Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.
Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.
Part of bp:api-ref-in-rst
Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56
2016年05月13日 13:35:24 +00:00
sharat.sharma
75280e582e Deprecated the concept of extensions in v2.1.
The extensions in api-ref-compute-v2.1 is deprecated. This patch
depricates the extension infrastructure in v2.1.
Change-Id: Ie7731c25ee7c5c662c22835add3314ffa51f37bc
Closes-Bug: #1490531 
2016年04月27日 15:26:03 +05:30
Sean Dague
e51b8f43e1 Add 'Show All' / 'Hide All' toggle
This adds a global control that does show / hide of all collapseable
sections. Which is extremely useful in seeing the entire API at once.
Part of bp:api-ref-in-rst
Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89
2016年04月15日 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016年04月13日 07:34:45 -04:00
Sean Dague
329898ffbc Add sample API content
This adds sample API content for versions and servers resources,
including the parameters.yaml that is needed in both of these cases.
It also makes a new tox.ini target 'api-ref' for building these docs,
which will be used as part of the publishing pipeline.
Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc
2016年03月29日 16:35:33 -04:00