Commit Graph

59 Commits

Author SHA1 Message Date
Jenkins fdeaa50dd2 Merge "api-ref: verify flavors.inc" 2016-05-20 14:59:36 +00:00
Jenkins 813787644b Merge "api-ref: complete verification of baremetal api" 2016-05-19 18:57:24 +00:00
Sean Dague e2688277bc api-ref: verify flavors.inc
This completes the verification of flavors.inc across all
phases. References to the 500 error that create could do have been
removed because it turns out that code isn't reachable any more (see
Ic848db8c3df75054c389e87b2405134262b531e2)

Part of bp:api-ref-in-rst

Change-Id: I9e89a737df558c930a2ca028ed169a5b3e383a3d
2016-05-19 08:12:46 -04:00
Sean Dague 0e5aa68f16 api-ref: complete verification of baremetal api
This cleans up the baremetal proxy, which was horribly inaccurate (the
paths weren't right after the method verification)

A warning is stuck in the preamble, we really don't want people using
this. Parameters are documented as best as we could from Nova
source. Honestly, people should just talk to ironic directly and use
their docs.

Part of bp:api-ref-in-rst

Change-Id: I66e85f414e5f0edbf052ba56691294a94615c619
2016-05-18 21:20:33 +00:00
Karen Bradshaw 39fc07b9c5 api-ref: servers-action-evacuate.inc
-Verify evacuate action method, examples, params.
-Update parameters.yaml with request
 parameter, on_shared_storage. Added
 field max_version, required == true.
 Update adminPass_evacuate_rebuild
 with max_version field for response.
-Updated headers with action name.

Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-17 17:23:39 -04:00
Jenkins 575d669318 Merge "api-ref: complete verification for os-flavor-access" 2016-05-17 10:15:30 +00:00
Jenkins 240cedf420 Merge "api-ref: complete verification of servers-action-crash-dump.inc" 2016-05-17 10:10:20 +00:00
Matt Riedemann 9bc797c80f api-ref: complete verification for os-flavor-access
This completes the parameter, example and body verification
for the os-flavor-access API.

The tenant_id_body parameter description was made more generic
to be able to reuse it here.

Part of blueprint api-ref-in-rst

Change-Id: I78755f0f92f8e742b668102b98ae15d94f8bf941
2016-05-16 12:54:08 -04:00
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
2016-05-16 08:50:59 -04:00
Kevin_Zheng 2813c837f6 api-ref: parameter verification for os-quota-sets
checked parameters

Part of bp:api-ref-in-rst

Change-Id: I0c43e83214aa4a0a54d553ab5c2ef79413753664
2016-05-16 14:48:06 +08:00
Sean Dague 94010b52ff api-ref: reorder parameters.yaml
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
2016-05-13 16:51:23 -04:00
Jenkins 103eeb8247 Merge "api-ref: Parameter verification for os-volume_attachments.inc" 2016-05-13 18:38:30 +00:00
Jenkins 903cf595d4 Merge "api-ref: finish validation for os-server-external-events.inc" 2016-05-13 17:54:01 +00:00
Takashi NATSUME 05b0da8062 api-ref: Parameter verification for os-volume_attachments.inc
Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741
Implements: blueprint api-ref-in-rst
2016-05-13 14:38:13 +00:00
Sean Dague 36c688f694 api-ref: finish validation for os-server-external-events.inc
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
2016-05-13 13:35:24 +00:00
Jenkins 74b115a473 Merge "api-ref: parameter validation for os-security-group-rules" 2016-05-13 13:16:00 +00:00
Jenkins a7f09fe706 Merge "api-ref: ips.inc parameter verification" 2016-05-13 11:07:22 +00:00
Jenkins 80fa358e86 Merge "api-ref: complete verification for extensions resource" 2016-05-13 00:56:21 +00:00
Sean Dague 04f8612aa9 api-ref: complete verification for extensions resource
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
2016-05-12 14:35:48 -04:00
Jenkins 355fa5307f Merge "Complete method verification of os-networks" 2016-05-12 16:05:58 +00:00
Ronald Bradford dfaf614c7a Complete method verification of os-networks
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
2016-05-12 11:28:27 +00:00
Augustina Ragwitz f7e4018a96 api-ref: ips.inc parameter verification
Part of bp:api-ref-in-rst

Change-Id: I929c186c3681b15b7e4c488ce81685deffde7ef0
2016-05-11 14:20:55 -07:00
Jenkins 167a203d84 Merge "api-ref host verification (os-hosts.inc)" 2016-05-11 16:58:20 +00:00
Jenkins 504a840008 Merge "api-ref verify os-floating-ip-pools.inc" 2016-05-11 16:57:23 +00:00
Matt Riedemann ad739f8e13 api-ref: parameter validation for os-security-group-rules
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
2016-05-11 11:23:40 -04:00
Jenkins 25ac5a2756 Merge "Added fault response parameter to Show Server Details API." 2016-05-11 15:20:59 +00:00
sharat.sharma 54dfffb842 Added fault response parameter to Show Server Details API.
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
2016-05-11 11:44:03 +00:00
Jenkins a99d74155b Merge "api-ref: perform all 4 phases of verification for action console output" 2016-05-11 06:55:10 +00:00
Sean Dague 549fe62bba api-ref: perform all 4 phases of verification for action console output
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
2016-05-09 16:48:34 -04:00
Sean Dague e131317430 api-ref: update parameter validation on servers
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
2016-05-09 16:23:10 -04:00
Jenkins cdd0125ae9 Merge "Changed the storage size from GB to GiB." 2016-05-04 00:11:06 +00:00
Atsushi SAKAI 340b7e9404 [doc] fix 5 typos
tweek        => tweak
adminstrator => administrator
mulitple     => multiple
definied     => defined (2-locations)

Change-Id: Ibe2c04e1b225515f7a6c83b5a4a8d91e8385140a
2016-04-28 20:40:18 +09:00
sharat.sharma 4c5ba52b74 Changed the storage size from GB to GiB.
Change-Id: Iede32b2764b9329bf9dc3d8aec02064db1f16d05
Closes-Bug: #1521791
2016-04-27 16:40:01 +05:30
jichenjc 4f716d9692 api-ref host verification (os-hosts.inc)
This verify the os-hosts by adding more reponse param
descriptions and body.

Part of bp:api-ref-in-rst

Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 16:45:06 +08:00
jichenjc 797e7094eb api-ref verify os-floating-ip-pools.inc
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
2016-04-26 15:37:33 +08:00
Sean Dague 9f6b96e333 Add links to API guide to describe links
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
2016-04-23 19:00:19 -04:00
Jenkins 9702e5d2e9 Merge "Final warnings removals for api-ref" 2016-04-20 18:10:59 +00:00
Jenkins 4b16974756 Merge "change host to host_migration" 2016-04-20 16:50:29 +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
Jenkins 9a0a52bf42 Merge "Fix os-server-groups.inc" 2016-04-20 14:23:12 +00:00
Jenkins 1e391f8dd6 Merge "Fix the parameters for os-agents API" 2016-04-20 11:15:38 +00:00
Jenkins 9504797297 Merge "Change adminPass for several server actions" 2016-04-20 11:04:20 +00:00
He Jie Xu 469771a3b5 Fix the parameters for os-agents API
* 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
2016-04-20 10:23:47 +08:00
jichenjc dfcd3a3c91 change host to host_migration
host param in migration refer to wrong link.

Part of bp:api-ref-in-rst

Change-Id: I7bf2459dace2cf0a90ae32f75ed734f533219c63
2016-03-24 04:39:50 +08:00
jichenjc 356aa087bb Fix os-server-groups.inc
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
2016-03-24 02:30:28 +08:00
jichenjc a248e6c60b Change adminPass for several server actions
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
2016-03-23 22:49:44 +08:00
Jenkins bb64ef88fd Merge "Fix "Creates an aggregate" parameters" 2016-04-19 13:24:40 +00:00
Jenkins 3f0865b22a Merge "Fix "Creates an agent build" parameters" 2016-04-19 06:33:35 +00:00
Ken'ichi Ohmichi b3e1afd087 Fix "Creates an aggregate" parameters
"Creates an aggregate" API supports multiple parameters on a request,
but api-ref doesn.t contain them at all This patch adds them.

The following JSON-Schema is for the API.
https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/schemas/aggregates.py#L32

Part of bp:api-ref-in-rst

Change-Id: I3a58568662d21059bccdcf64cc30dbf3b706db58
2016-04-18 14:25:24 -07:00
Sean Dague 46a1fd17cc Update servers.inc to be as accurate as api-site
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
2016-04-18 06:40:23 -04:00