Proxy APIs are deprecated in microversion 2.36 which means
all proxy APIs will return 404 after 2.35 version.
It will be nice to mention that explicitly in api-ref too.
Partially implements blueprint deprecate-api-proxies
Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82
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
This cleans up the baremetal proxy, which was horribly inaccurate (the
paths weren't right after the method verification)
A warning is stuck in the preamble, we really don't want people using
this. Parameters are documented as best as we could from Nova
source. Honestly, people should just talk to ironic directly and use
their docs.
Part of bp:api-ref-in-rst
Change-Id: I66e85f414e5f0edbf052ba56691294a94615c619
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 fixes the last json reference warning which exist. It also trims
out the baremetal API calls that we don't support any more (we only
have the readonly proxy). That was erroneously added to the compute
API docs in refactors of api-site last cycle.
Change-Id: I08be639b610304049b0959902ed8876559111274
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
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.
Part of bp:api-ref-in-rst
Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
The api-ref os-baremetal-nodes doesn't contain normal status code,
so this patch adds it for explaining the normal opperation.
Part of bp:api-ref-in-rst
Change-Id: I1e1e9ee37b1a8c0511438fa9a2e447c7d8df8d0f
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