16 Commits

Author SHA1 Message Date
ghanshyam
a41d396152 api-ref: verify images.inc
This completes the verification of images.inc for
all required area(parameter, example, body)

Part of bp:api-ref-in-rst

Change-Id: I47ed4d0b4446a0b45a1df312b84ec6bfdaa134b6
2016-06-24 14:35:23 +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
Sarafraj Singh
cf69f5c664 api-ref: image.inc - Update method validation
1. Arranged all methods in canonical order
2. Validate all methods

Part of bp:api-ref-in-rst

Change-Id: If13ad63f0035e33cc1d9ea31315e64331deb5554
2016-05-16 10:49:23 +00: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
Jenkins
9702e5d2e9 Merge "Final warnings removals for api-ref" 2016-04-20 18:10:59 +00:00
Jenkins
397a3a3ef1 Merge "modify duplicate // to / in doc" 2016-04-20 15:46:16 +00:00
Sean Dague
1555736e3c Final warnings removals for api-ref
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.

It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.

Part of bp:api-ref-in-rst

Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:25:30 -04:00
Sean Dague
f208917c52 Fix remaining json reference warnings
This fixes the last json reference warning which exist. It also trims
out the baremetal API calls that we don't support any more (we only
have the readonly proxy). That was erroneously added to the compute
API docs in refactors of api-site last cycle.

Change-Id: I08be639b610304049b0959902ed8876559111274
2016-04-20 08:42:24 -04:00
ghanshyam
27778e5d04 Add remaining image API ref
This commit adds remaining image and metadata API ref
and also correct the existing one with status code and
sample file name.

Part of bp:api-ref-in-rst

Change-Id: I9db88b0ad042501406d512e417440a1146027326
2016-04-19 23:31:47 +00: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
jichenjc
11a79609e3 modify duplicate // to / in doc
Part of bp:api-ref-in-rst

Change-Id: I1da87f0e8f0a6b45d60be58af2d13c8a236469d3
2016-03-24 05:01:06 +08: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