19 Commits

Author SHA1 Message Date
Vu Cong Tuan
605d617d55 Repair links in Nova documentation
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
2017-05-23 17:17:52 +07:00
jichenjc
4aaa8bc0bf Clean up metadata param in doc
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
2017-02-25 21:45:05 +08:00
Jenkins
36eb305b97 Merge "Add offset & limit docs & tests" 2017-02-09 14:17:36 +00:00
Diana Clarke
fdba403d09 Add offset & limit docs & tests
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
2017-02-02 12:28:06 -05:00
jichenjc
deac17c4f9 Better wording for micorversion 2.36
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
2016-12-10 18:49:13 +08:00
Takashi NATSUME
5e9add3d10 api-ref: Fix wrong parameters in os-volumes.inc
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
2016-10-17 09:35:23 +00:00
ghanshyam
b4d0b9a11c Mention proxy API deprecation microversion in api-ref
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
2016-08-01 14:59:53 +09:00
Chen Fan
f27a0e7ccc api-ref: unify the no response output in delete operation
Change-Id: Ia90a5ef1cd1b432e68130313960a015b45fe63e0
Implements: blueprint api-ref-in-rst
2016-07-25 16:13:45 +08:00
Karen Bradshaw
e551452d6c api-ref: os-volumes.inc
-Verified examples, parameters, body text.
-Added snapshot status values, new force parameter
 for snapshots.

Part of: bp/api-ref-in-rst

Change-Id: I0c1d183c5aaf6fb796be30fa5627bd5644ea689f
2016-07-04 15:39:42 +00:00
ghanshyam
40ea165e81 Publish proxy APIs deprecation in api ref doc
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
2016-06-14 15:31:18 +09: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
Anusha Unnam
032395caca api-ref: os-volumes.inc method verification
Verified the API document with source for methods available
and response codes used.

Part of bp:api-ref-in-rst

Change-Id: Ic3c0dc56a905985a62d719c9d05db1cf4d1c1000
2016-05-13 11:28:18 +01: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
Sean Dague
516bd072bc Fix api samples references in 3 more files
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
2016-04-19 14:08:33 -04:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +00: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
Ken'ichi Ohmichi
05e9f0a0e0 Remove 40X and 50X from Normal response codes
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
2016-04-18 16:56:11 -07: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