13 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
Matt Riedemann
f9bfb72a1c api-ref: add notes about POST/DELETE errors for os-tenant-networks
After microversion 2.35 all of the os-tenant-networks methods will
return a 404 response. However, before that, if using neutron:

- POST will return a 503 error because the NotImplementedError is
  caught and translated to the 503.
- DELETE will return a 500 error because the NotImplementedError
  is NOT caught so results in a 500.

The API reference only noted that the API is deprecated since the
2.36 microversion but doesn't note that POST and DELETE are not
implemented, so this adds those details for unsuspecting victims.

Change-Id: I7f256a4c1a6e4247698fcb5ee7c56128c517e29b
Closes-Bug: #1652252
2016-12-29 16:44:22 -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
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
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
Ronald Bradford
68e7462d08 Complete method verification of os-tenant-networks
Verified the API document with source for methods available and response
codes used.
Recorded HTTP methods to match wiki.

Part of bp:api-ref-in-rst

Change-Id: I4a007d23285b10725123cbfe5554c0964ae798a0
2016-05-09 16:21:54 -04: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
d0eb85880c Remove duplicate api ref for os-networks/actions
This remove the duplicate entry of os-networks/actions api ref
and add the action name in their content.

Part of bp:api-ref-in-rst

Change-Id: I3ca28793b6bcf390c8a2bfa1dfcf0213cf6bd428
2016-04-20 17:11:06 +09: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
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