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
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
Verified the API document with source for methods available and response
codes used.
Recorded HTTP methods to match wiki.
Part of bp:api-ref-in-rst
Change-Id: I4a007d23285b10725123cbfe5554c0964ae798a0
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
This remove the duplicate entry of os-networks/actions api ref
and add the action name in their content.
Part of bp:api-ref-in-rst
Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
This fixes more api samples references which were autogenerated
incorrectly, and brings our api-ref warnings down to 175.
It also removes the os-volume-types API references, which turns out to
be a complete work of fiction, and never existed.
Part of bp:api-ref-in-rst
Change-Id: I1395c5e5986d8810ed91e9c9f132ec04f620497c
Heading for json response example is wrong,
it is json request instead of json response.
Part of bp:api-ref-in-rst
Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
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