15 Commits

Author SHA1 Message Date
Takashi NATSUME
2800b53836 api-ref: Fix keypair API parameters
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
2017-03-10 15:58:06 +09:00
Diana Clarke
29c6e08fe8 api-ref: use the examples with paging links
Use the microversion response samples that include the paging links in
the example JSON responses.

Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-05 10:56:13 -05:00
Matt Riedemann
be11fab555 api-ref: remove user_id from keypair list response and fix 2.10
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
2016-11-04 10:31:29 -04:00
jichenjc
7b9e340c80 Add keypairs_links into resp
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
2016-09-09 21:39:55 +08:00
Pavel Kholkin
47358449d3 Microversion 2.35 adds keypairs pagination support
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
2016-07-12 19:48:05 +03:00
Sujitha
05c7b6fa30 Add user_id request parameter in os-keypairs list
Added user_id in request parameter section of the
os-keypairs LIST method api-ref docs.

Closes bug: #1599911

Change-Id: Ibb52663b2890f6d46b125903b438c0142aba92f5
2016-07-11 20:56:05 +00:00
Chen Fan
377948b059 api-ref: unify the delete response infomation
part of bp:api-ref-in-rst

Change-Id: I924a632253b8b1c25f987c259d255cc6440f52f2
2016-07-07 10:23:34 +08:00
Sean Dague
f06a12623b api-ref: verify keypairs
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
2016-06-08 08:23:33 -04: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
jichenjc
d963a27fa6 Complet Method Verification of keypair
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
2016-04-23 02:36:51 +08:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
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
2016-04-20 16:21:58 -04:00
ghanshyam
1d6cd1277b Fix content and sample file for keypair, migration, networks
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
2016-04-20 12:03:04 +09:00
ghanshyam
6f8cda2f39 Fix json response example heading in api ref
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
2016-04-19 17:56:20 +09:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
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
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