Some reference links are out of date.
There's 404 error when trying to access them.
For example:
http://developer.openstack.org/api-ref/networking/
v2-ext/index.html#security-groups-security-groups
Change-Id: Iead6a6f32cdb2c9067bb5425333ad043514edbce
several params like metadata_xxx are used and actually they are
same, so just clean up them and use metadata_object instead
part of bp:api-ref-in-rst-pike
Change-Id: I455c02b5dcd77df43fc8c0113269f71a5207d3d5
A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.
- os-cells
- os-security-groups
- os-server-groups
- os-snapshots
- os-virtual-interfaces
- os-volume-attachments
- os-volumes
Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a
make it follow other descriptions, use start from to make
it clear 2.36 is the first microversion deprecate those proxy
Implements: blueprint api-ref-in-rst-ocata
Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367
In os-snapshots APIs, the display name is the snapshot name,
not the volume name.
The display description is the snapshot description,
not the volume description.
So fix them.
Change-Id: I33cd59b759c6f7c8eca8bd511ba43637e7b27c1c
Closes-Bug: #1611292
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
-Verified examples, parameters, body text.
-Added snapshot status values, new force parameter
for snapshots.
Part of: bp/api-ref-in-rst
Change-Id: I0c1d183c5aaf6fb796be30fa5627bd5644ea689f
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.
Part of bp:api-ref-in-rst
Change-Id: Ic3c0dc56a905985a62d719c9d05db1cf4d1c1000
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 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
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
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