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 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
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
The api-ref os-baremetal-nodes doesn't contain normal status code,
so this patch adds it for explaining the normal opperation.
Part of bp:api-ref-in-rst
Change-Id: I1e1e9ee37b1a8c0511438fa9a2e447c7d8df8d0f
This fixes the samples references for ``servers-actions.inc`` and
``servers-multiple-create.inc`` and drops the warnings count to 195.
Change-Id: Id9a2ae98f5ded9ab57bfd3af5fb18357df6bc1d2
This updates servers.inc which had a rough path during conversion. The
GET servers/details was lost entirely.
It updates a number of parameters to distinguish ones that are only in
the queries, as well as fixes references to short names that collided.
It updates the UPDATE call to only specify request parameters which
you can actually update.
It introduces the notation object.field for parameters that are
embedded in other objects. This is a new concept, but one way we can
clear up that the uuid in the parameter list is really networks.uuid.
It also deletes the old hand rolled servers.rst, which drops the
warnings count by nearly 100.
Part of bp:api-ref-in-rst
Change-Id: Ie7693a5888efa913118244a0837e6c0177965d48
This fixes a number of issues in the versions.inc reference
document.
Documents all the useful parameters in the response (we really need to
do something about the ones that are not).
Fix links to samples content, and write some text explaining them.
Parametrize the {api_version} GET call, it was weird to list all the
hard coded values there.
Add a couple of inline todos for longer additional references we
should do.
Part of bp:api-ref-in-rst
Change-Id: I56e5e922fca39453d0d9fc062a84daba7cad8cc1
This ensures all parameter tables are 100% wide, even if they have
only a few items with short descriptions. It makes all the tables the
same width.
This moves the link icon into the gutter for the main content, and
makes it hidden by default (only visible on hover) like in the API
site today.
This makes the link + method name div be ``white-space: nowrap`` to
ensure that when the screen gets narrower the Delete button doesn't
fold up on itself.
Part of bp:api-ref-in-rst
Change-Id: I3892e6c8e3c01956d63a33603ba1bf9146d21161
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
The blockquote font size is 17.5px in bootstrap where normal text is
14px. This is because blockquote is thought of for doing pull
quotes. However sphinx uses block quote for indented text, and it
should thus be the same as the body text.
Part of bp:api-ref-in-rst
Change-Id: I4135686416d84f5ca113a031534c3486a4c2b1c5
This adds a global control that does show / hide of all collapseable
sections. Which is extremely useful in seeing the entire API at once.
Part of bp:api-ref-in-rst
Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89
