04de167e379bc47ea1bff07c98f0dd785cf328f3
7 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
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 |
||
|
Sean Dague
|
d790fe0087 |
api-ref: complete verification of servers-action-crash-dump.inc
This processes all 4 phases of the crash-dump action * method verified, error codes cleaned up (extra explanation added where appropriate) * action parameter added * example verified * body adds warning and versionadded stanzas Part of bp:api-ref-in-rst Change-Id: I6571a3981d25ab4b5459715c9d2061ad19f07f26 |
||
|
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 |
||
|
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 |
||
|
Kevin_Zheng
|
f6592c94fd |
Fix api sample references in 2 more files.
The api sample reference is not correct fix incorrect return value. 1. servers-action-console-output.inc 2. servers-action-crash-dump.inc Part of bp:api-ref-in-rst Change-Id: Id0d946478a6a59f63f22117944309d3eb66013d3 |
||
|
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 |
||
|
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 |