Fix parameter types and the order of parameters.
Add missing parameters.
Add a period at the end of a parameter description.
Replace sample files with v2.10 files.
Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302
Closes-Bug: #1656781
Use the microversion response samples that include the paging links in
the example JSON responses.
Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
The user_id has always been returned for the keypair create and
show operations. The user_id has never been returned in the list
response. The docs were a bit confusing for create and show since
they said 'New in version 2.10' for the user_id description in the
response.
This change clarifies the response docs so that we don't make it
sound like user_id is only getting returned for create/show with
microversion 2.10 and removes user_id from the response docs for
the list operation.
Change-Id: I4bd06c8ed88e526f44bb0d6e927c09175bf103b1
Closes-Bug: #1638606
v2.35 added keypairs_links into resp param list,
this patch added it to the api-ref
Implements: blueprint api-ref-in-rst
Change-Id: Id62dc61c169c772510b727b7666ae38a555e4247
After this microversion Nova API allows to get several keypairs
with the help of new optional parameters 'limit' and 'marker'
which were added to GET /os-keypairs request.
Partial-Bug: #1599904
Implements blueprint: keypairs-pagination
Change-Id: Idd3757f5be90ec4af1bd1a7ca3f9c20319dbfd33
Added user_id in request parameter section of the
os-keypairs LIST method api-ref docs.
Closes bug: #1599911
Change-Id: Ibb52663b2890f6d46b125903b438c0142aba92f5
This verifies all the parts of keypairs, including filling out all the
details for microversion 2.2 and 2.10 which change it.
Part of bp:api-ref-in-rst
Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
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 doc for os-keypairs,
Also, remove some common error code like 500, 503 etc
detail log: http://paste.openstack.org/show/495427
Part of bp:api-ref-in-rst
Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
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 fix some content and sample file path for:
-os-keypairs
-os-migrations
-os-networks
Part of bp:api-ref-in-rst
Change-Id: I6ae6d38207c5a9552bab9a42b2800449e4ad040a
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