449 Commits

Author SHA1 Message Date
Matt Riedemann
c175c8d579 api-ref: document the power_state enum values
The OS-EXT-STS:power_state attribute in a server GET response
is enum values which are meaningless unless you look at the
nova/compute/power_states.py code. This change adds a mapping
to the description on that field in the api-ref.

Note there are gaps in the sequence, those are for unused values
as seen in the nova.objects.fields.InstancePowerState class.

Change-Id: I2ef9f493e66ab04b13f439e73247dc306a1514b4
2016-11-01 17:39:17 -04:00
Takashi NATSUME
5e9add3d10 api-ref: Fix wrong parameters in os-volumes.inc
In os-snapshots APIs, the display name is the snapshot name,
not the volume name.
The display description is the snapshot description,
not the volume description.
So fix them.

Change-Id: I33cd59b759c6f7c8eca8bd511ba43637e7b27c1c
Closes-Bug: #1611292
2016-10-17 09:35:23 +00:00
Jenkins
26fd2eabb0 Merge "Fix API doc for os-console-auth-tokens" 2016-10-10 12:38:49 +00:00
Jenkins
bf3035506f Merge "Fix typo on api-ref parameters" 2016-10-06 19:53:06 +00:00
Radoslav Gerganov
d04e41e72b Fix API doc for os-console-auth-tokens
There are multiple errors in the API doc for os-console-auth-tokens
(name, description, params). This patch fixes them.

Closes-Bug: #1602293

Change-Id: Ia3d678b4d9fc5b768088224d0338c8e97c761b3c
2016-10-06 18:09:52 +03:00
Hironori Shiina
935bea2045 Fix a few typos in API reference
Change-Id: Ib90100f4ec6b4b03f27ed39166caeb9bdf5bc24c
2016-09-28 14:34:23 +09:00
Atsushi SAKAI
4a6bf432b0 Fix typo on api-ref parameters
The => the

Change-Id: I08fedb0d24b0cb79369b0341e9fc92d960b7e76a
2016-09-28 14:28:51 +09:00
jichenjc
f81e32c9d1 Add more description when service delete
As service delete will affect host aggregate, add more info

Change-Id: I57b17f60228df83a033735c33cc74589dad30553
Implements: blueprint api-ref-in-rst-ocata
2016-09-21 20:18:18 +08:00
Ha Van Tu
a68cd911d1 [api-ref] Correct parameter type
`OS-EXT-SERV-ATTR:launch_index` parameter should be `integer`
instead of `int`.

Change-Id: I598ac4f310008933d1ddf2eff9f2e68fa2c76edc
2016-09-20 17:20:37 +07:00
Jenkins
2468784fcb Merge "[api-ref] Update configuration file" 2016-09-19 16:39:09 +00:00
Jenkins
451db85c78 Merge "doc: fix disk=0 use case in flavor doc" 2016-09-19 16:38:06 +00:00
Jenkins
f6a3fccfe2 Merge "Updates URL and removes trailing characters" 2016-09-19 14:35:51 +00:00
Jenkins
983cc7c75e Merge "Add link ref to nova api concept doc" 2016-09-19 14:16:49 +00:00
Jenkins
c2341b5112 Merge "Add description for v2.20 changes in api-ref" 2016-09-19 14:16:22 +00:00
Jenkins
3a4c03dbe0 Merge "Add hypervisor_links into hypervisor v2.33" 2016-09-19 10:47:56 +00:00
Jenkins
2fb995a8ab Merge "Add keypairs_links into resp" 2016-09-19 09:15:22 +00:00
Jenkins
27a4b1744c Merge "Body Verification of api-ref os-volume-attachments.inc" 2016-09-19 08:57:03 +00:00
Jenkins
b624bec672 Merge "Complete verification for os-virtual-interfaces" 2016-09-19 08:45:38 +00:00
He Jie Xu
b2ee12ce19 Add link ref to nova api concept doc
This patch adds link to the api concept doc.

Change-Id: I3c9f7ebce7f4241a41492511b39f8649190b53eb
Partial-implements: blueprint api-ref-in-rst-ocata
2016-09-19 10:35:14 +08:00
Jenkins
29e2c41092 Merge "Add reserved param for v2.4" 2016-09-19 02:27:15 +00:00
Jenkins
8230aedb80 Merge "Trivial fix remove not used var in parameters" 2016-09-18 13:11:42 +00:00
ianeta hutchinson
2f202bb3e3 Updates URL and removes trailing characters
Removes trailing '`_' and updates URL to be consistent with rest of
document by providing a full sentence.

Closes Bug: 1621891

Change-Id: Iea47703b624db6de0912abe7ad42a018596d951e
2016-09-16 10:51:28 -05:00
stewie925
2b4ac81cf8 Body Verification of api-ref os-volume-attachments.inc
This patch verifies that the title and introductory description 
that precedes each rest method clearly reflects the context of the 
respective rest method.  Thus no changes are necessary - the
'body verification' tag is removed for this commit.

part of bp:api-ref-in-rst

Change-Id: I61cfdb5a0b8f8e1d8d60bd306c4952f2bc9ec537
2016-09-14 16:16:26 +00:00
jichenjc
a4c86804e6 Add description for v2.20 changes in api-ref
v2.20 allows shelved and shelve_offload instance to attach and
detach volume, add descriptions for that

Implements: blueprint api-ref-in-rst-ocata
Change-Id: Ib1349c2ef9d69cfc74212fd48ff10f913a5ce134
2016-09-10 05:23:01 +08:00
jichenjc
7b9e340c80 Add keypairs_links into resp
v2.35 added keypairs_links into resp param list,
this patch added it to the api-ref

Implements: blueprint api-ref-in-rst

Change-Id: Id62dc61c169c772510b727b7666ae38a555e4247
2016-09-09 21:39:55 +08:00
Jenkins
355b94f3c3 Merge "[api-ref]: Correcting server_groups_list parameter's type." 2016-09-14 16:51:15 +00:00
Jenkins
62412ad454 Merge "[api-ref]: Update link reference" 2016-09-14 16:50:30 +00:00
Jenkins
04e94df911 Merge "Fix api-ref doc for server-rebuild" 2016-09-14 15:31:47 +00:00
Jenkins
0f9de41cba Merge "[api-ref] fix availability_zone for server create" 2016-09-14 12:46:57 +00:00
Jenkins
d3c9c476fc Merge "Complete verification for os-cloudpipe.inc" 2016-09-14 11:46:13 +00:00
ghanshyam
485ae14c9c Correct image.inc for heading
This commit updates image.inc to remove create
and update image from title

Partially implements blueprint api-ref-in-rst

Change-Id: Ib9aea5fd26585f6b81addfe4f0cdea00f2b2eaf5
2016-09-14 16:11:12 +09:00
ghanshyam
3309ad7338 Complete verification for os-cloudpipe.inc
This commit verify everything for cloudpipe.inc

Also mark this API deprecated as it works only for
nova-networks.

Partially implements blueprint api-ref-in-rst

Change-Id: I415760ff634dd85974f0c3f79e788e633852efb5
2016-09-14 07:06:06 +00:00
Jenkins
4014ebec5e Merge "Correct address, version parameter in ips.inc" 2016-09-13 20:34:02 +00:00
Jenkins
7e8fbabf45 Merge "Correct sort_key and sort_dir parameter for flavor" 2016-09-13 20:33:34 +00:00
Jenkins
30998a18c9 Merge "Fix server group name on api-ref" 2016-09-13 14:34:29 +00:00
ghanshyam
d7948387b1 Correct sort_key and sort_dir parameter for flavor
This commits define new parameter sort_key_flavor
and sort_dir_flavor for flavor List API and define
the correct default values for those.

Partially implements blueprint api-ref-in-rst

Change-Id: I2915a5bccebfeddf66c825b0272af86e3fd7da19
2016-09-13 08:28:26 +00:00
ghanshyam
b343e96fb4 Correct address, version parameter in ips.inc
'osapi_hide_server_address_states' does not hide the
address field in server/ips APIs so address paramater
for this API is wrong and this commit fis the same.

Also fixing the 'version' parameter.

Partially implements blueprint api-ref-in-rst

Change-Id: I22d6ab97d14779fe3a32c23a5148b4eb59f1034f
2016-09-13 05:52:39 +00:00
Jenkins
5b207f9a13 Merge "Example & Parameter verification of os-security-group-default-rules.inc" 2016-09-13 01:46:47 +00:00
Jenkins
ba718e35db Merge "fixing block_device_mapping_v2 data_type" 2016-09-13 00:18:00 +00:00
Ken'ichi Ohmichi
99e012290b Fix server group name on api-ref
The parameter 'name' is for security group, not server group.
This patch fixes the description.

Partially implements blueprint api-ref-in-rst

Change-Id: I954b91c47bf4766be430ace2783089c7f59f9324
2016-09-12 14:37:57 -07:00
tengqm
73c4c001d6 [api-ref] fix availability_zone for server create
The 'availability_zone' parameter was incorrectly documented as
'os-availability-zone:availability_zone'. This patch fixes it.

Change-Id: I9837a747b40c9ef933a89acbdab9360ade1012a8
2016-09-12 05:47:47 -04:00
jichenjc
6178700598 Add hypervisor_links into hypervisor v2.33
added hypervisor_links into response of hypervisor we need to
add it

Also, verified sample.

Implements: blueprint api-ref-in-rst

Change-Id: I38241f116482a99609e5892a9e20ea5496d89f2b
2016-09-09 21:28:19 +08:00
jichenjc
c1a8b89504 Add reserved param for v2.4
v2.4 added 'reserved' param to fixed ip output, this patch
added it into doc.

Change-Id: I3be65d6aa5e36662cbb09f408124d0abb8bbfdf5
Implements: blueprint api-ref-in-rst-ocata
2016-09-09 20:21:47 +08:00
tengqm
fc9a540482 Fix api-ref doc for server-rebuild
This fixes the name parameter which should be referencing the optional
server name instead of the security group name. It also deletes an entry
in the parameters.yaml which is not referenced anywhere.

Change-Id: I38abe55aa46f54a22468e21188e0cd5ef2c63244
2016-09-08 23:04:43 -04:00
Ha Van Tu
174f5a0a21 [api-ref] Update configuration file
This patch updates the configuration file by removing the redundant
lines.

Change-Id: I2811af505f87a9f47e55410d8d0178414a44fe5f
2016-09-09 09:53:24 +07:00
jichenjc
59dd4a48b9 fix broken link in api-ref
the link is broken, replace with new link

Change-Id: Ic38600f06519c3fa509dfba1b2c614c9330e35fd
Implements: blueprint api-ref-in-rst
2016-09-09 10:40:19 +08:00
jichenjc
054e3a52a5 Trivial fix remove not used var in parameters
Change-Id: I2714840f73d01b35737866c8e1a79c728ccf6a99
Implements: blueprint api-ref-in-rst
2016-09-09 10:13:10 +08:00
ghanshyam
f5b7a333ff Example & Parameter verification of os-security-group-default-rules.inc
This patch verifies the example & parameters of
os-security-group-default-rules.inc

part of bp:api-ref-in-rst

Change-Id: I1e94aad4c9f763c41d921d761c215cc2de03af5a
2016-09-07 12:31:25 +00:00
Nguyen Phuong An
c2cc95097b [api-ref]: Correcting server_groups_list parameter's type.
This patch changes type 'list' to 'array' in server_groups_list because
we don't have 'list' type.

Change-Id: Ibb443ab6f88da7c4cfc53bfbf102c518abaea9ac
2016-09-06 02:13:05 +00:00
tamilhce
2ad6aa9116 fixing block_device_mapping_v2 data_type
'block_device_mapping_v2' should be an list type
Closes-Bug: #1619833

Change-Id: Id7fa0e1dc2cff6438e82ad83b2087f67e0fa628b
2016-09-03 16:09:27 +00:00