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
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
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
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
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
* Add notes for API bug: update return string type's agent id
* Fix the parameters for create agent
* Fix the description of agent id in the update url.
Part of bp:api-ref-in-rst
Change-Id: I5c102ef8a08123089ec4a85dde5716eda12fb8c7
This fix sample file path and some satatus code for
-fixed ips
-floating ips
Part of bp:api-ref-in-rst
Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65
This fix all sample file path for
-os-aggregates
-os-certificates
-os-consoles
Part of bp:api-ref-in-rst
Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
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
This fixes the samples references in the security group files,
commenting out 2 that don't exist at all.
This drops the warnings to 145 against current master.
Part of bp:api-ref-in-rst
Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8
This fixes all the samples references in os-services to not throw
warnings.
Part of bp:api-ref-in-rst
Change-Id: I25b469352a4f99e34783eb31ea3b94e4d9971477
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
This patch fix API ref for correct sample files and status code
for below APIs
- os-hosts
- os-quota-sets
- os-fping
Part of bp:api-ref-in-rst
Change-Id: I7ecfe5adf4d8f1e9c767bac9194d9160f09fbee9
This patch fix API ref for correct sample files and status code
for below APIs
- os-cells
- os-cloudpipe
- server-action-shelve
Part of bp:api-ref-in-rst
Change-Id: I6292f78742d7bb50882e186c97e7966721037ba4
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
This patch fix API ref for correct sample files and status code
for below APIs
- ips
- limits
- server metadata
- agents
Part of bp:api-ref-in-rst
Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732
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
