This reorder's parameters.yaml to the correct sort order, and turns
the info message about incorrect ordering into a warning. After this
lands parameters.yaml changes will always require that the items stay
in the sorted order enforced by the extension.
Part of bp:api-ref-in-rst
Change-Id: Ib890d369a8b50a8cd920f7b19ef13f44b3e657df
This completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.
Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.
Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.
Part of bp:api-ref-in-rst
Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56
This completes all 4 phases of the extensions resource.
* List method was added
* Error codes updated as exist in code
* Updates parameters.yaml to match actual descriptions for parameters
* Update body to be a lot stronger about what our deprecation means and why.
Part of bp:api-ref-in-rst
Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561
Verified the API document with source for methods available and
response codes used. Recorded HTTP methods to match wiki.
Marked the associate/disassociate sections as deprecated (as they are
nova-net only), and added some warnings in the docs about their use.
Part of bp:api-ref-in-rst
Change-Id: I63c56a546fe3a97eaa16ce41999593eaf650b538
Cleans up a bunch of the types and descriptions for the
parameters.
Removes some extraneous unused parameters.
Added descriptions for the request and response to point out
that group_id and cidr are optional but one or the other is
required and depending on what comes in the request influences
what comes back in the response.
Part of blueprint api-ref-in-rst
Change-Id: I1084fa7ec46373cc989d1d93bb667ac59a62e38a
The Show Server Details returns fault field in the failed
responses. This patch adds the fault field to the response
parameter table.
Change-Id: I413a098061eb58ba70b3a18d646398dfdac590aa
Closes-Bug: #1545972
This provides the verification of the action console output.
* Return codes updated based on what's in the code
* Parameters fixed (length -1 is not actually a thing, it's suggestion
for future enhancement; console output described; server_id should be in path).
* Add preamble for request example
* Clean up language on preamble
Part of bp:api-ref-in-rst
Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b
This updates all the v2.1 parameters for servers, as well as some of
the microversions added parameters. It makes us more accurate than the
existing api-site.
This specificially *does not* include the additional response
parameters for microversions > 2.1 (tags, ext attrs for ec2, etc).
Part of bp:api-ref-in-rst
Change-Id: Ic03c0e6486a300c3cd724b798850dedeae014faf
This verify the os-hosts by adding more reponse param
descriptions and body.
Part of bp:api-ref-in-rst
Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
verified the API doc for os-floating-ip-pools,
adjus the wording for 'owner' of the server, Also,
remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: Id8bd213282bc53f1f9fbc24d1d2b03ea135c376e
We have a pretty generic parameter for links, which lets us reuse it,
which is good. This updates the description to link to the API guide
to explain the concepts on links.
Part of bp:api-ref-in-rst
Change-Id: Ic05428cf20ee8652c09b993046d491453c328a4c
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
* 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
some json reponse/request reference not correct
fix incorrect return value.
Also, change id reference to server_group_id.
Part of bp:api-ref-in-rst
Change-Id: Ia1fc10301dfa35087658d311bec684d43c8e0929
adminPass has incorrect reference, thus every input param
are same ,but actually they are different. updated it with its
correct link reference.
Part of bp:api-ref-in-rst
Change-Id: Ie981a0912768effbe796bfc1d26d4972ba667b90
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
In swagger the attribute for required/optional is 'required', so we've
decided that's a better way to specify our parameters. This changes
the sphinx parser to use that when inserting (optional) into the
table.
We also make all 'path' parameters required, because we never specify
them in a table where they are not. I think them all being required:
false was an artifact of the data processing.
Part of bp:api-ref-in-rst
Change-Id: Ie2d012741d69430546fe1b10c9f16c853acb926a
This is the output of fairy-slipper conversion, merged into a single
file, with some error collision put into place. This will require some
unwinding of content because of the collisions that exist in keys, but
that can be done manually post import.
Change-Id: I430ed66728a6ac009f23e6ff8a65a3ec01c21327
This adds sample API content for versions and servers resources,
including the parameters.yaml that is needed in both of these cases.
It also makes a new tox.ini target 'api-ref' for building these docs,
which will be used as part of the publishing pipeline.
Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc
fix api-sample reference to flavors
make some changes to os-virtual-interfaces so don't talk
about microversion in contents(will add microversion later)
also, fix id param reference
Part of bp:api-ref-in-rst
Change-Id: I6eb8a14fce1c1048506cd5b990576ca5ecf44b6c
Kevin_Zheng