Commit Graph

186 Commits

Author SHA1 Message Date
jichenjc f853a5c4be Add description for 2.9 microversion
2.9 added locked param to view builder of servers
several actions are affected.

Rebuild action will be in another separated patch to
add whole response of rebuild action.

Change-Id: I366b5f43b971b4315f006d2b4a223de4fcaef78a
Implements: blueprint api-ref-in-rst-ocata
2016-11-28 22:26:08 +08:00
Ken'ichi Ohmichi 9a5c20af7f Add block_device_mapping_v2.uuid to api-ref
The sample of block_device_mapping_v2 contains uuid as a parameter
but there is not any explanation of the parameter.
This patch adds it to api-ref.

The following is for explaining the parameter from the code.

  As the following code, source_type is "image" and api_dict["image_id"]
  can be glance image-id on the sample case.

  https://github.com/openstack/nova/blob/master/nova/block_device.py#L197
    api_dict[source_type + '_id'] = device_uuid

  The "image_id" is used for getting image metadata from Glance:

  https://github.com/openstack/nova/blob/master/nova/compute/api.py#L1072
    image_id = bdm['image_id']
    image_meta = self.image_api.get(context, image_id)

Change-Id: I83badab07446c2b1e55cc3b29a3ba9476efc179d
2016-12-01 19:15:14 -08:00
Jenkins 8dafe05b42 Merge "api-ref: add missing os-server-groups parameters" 2016-11-29 11:30:54 +00:00
Diana Clarke dba04d511c api-ref: add missing os-server-groups parameters
The os-server-groups endpoint has supported paging using optional
'limit' & 'offset' query parameters for years now, but they aren't
documented in the api-ref. This patch adds those query parameters to the
nova api documentation.

Change-Id: Ifc234da617c31f1f22674b306fdd6e398041973a
2016-11-22 11:27:46 -05:00
stewie925 2ecbbd8d43 Complete verification for os-floating-ips
This includes the parameter, example, and body
verification for os-floating-ips.

part of bp:api-ref-in-rst-ocata

Change-Id: I4beff34b41baf77827a2e4d916ad5319bdefbfa1
2016-11-21 14:49:35 -08:00
Jenkins 22306bb8f5 Merge "Remove unused parameters" 2016-11-16 10:24:02 +00:00
Matt Riedemann 7d33dc85f5 api-ref: parameter verification for server-migrations
This completes the parameter verification for the server-migrations
API.

Partial-Bug: #1641713

Part of blueprint api-ref-in-rst-ocata

Change-Id: I94ac520b35f4e6a042456c67bc713202fd8c3c91
2016-11-14 17:26:54 -05:00
Jenkins f21ba22fa9 Merge "api-ref: fix addFloatingIp action docs" 2016-11-11 17:28:56 +00:00
Matt Riedemann 0f26e6872e api-ref: fix addFloatingIp action docs
As described in the bug, the addFloatingIp parameter
in the request body is an object, not a string. And we
didn't actually have an example request, so one is added
here to further clarify the API.

Change-Id: I366ba880cf13558291da286e6524327cafcccf1f
Closes-Bug: #1636185
2016-11-07 11:32:31 -05:00
Matt Riedemann be11fab555 api-ref: remove user_id from keypair list response and fix 2.10
The user_id has always been returned for the keypair create and
show operations. The user_id has never been returned in the list
response. The docs were a bit confusing for create and show since
they said 'New in version 2.10' for the user_id description in the
response.

This change clarifies the response docs so that we don't make it
sound like user_id is only getting returned for create/show with
microversion 2.10 and removes user_id from the response docs for
the list operation.

Change-Id: I4bd06c8ed88e526f44bb0d6e927c09175bf103b1
Closes-Bug: #1638606
2016-11-04 10:31:29 -04:00
Matt Riedemann 1d5442808e api-ref: cleanup bdm.delete_on_termination field
This makes two changes for the block_device_mapping_v2
delete_on_termination parameter reference:

1. Identifies that it's optional.
2. Identifies that if not specified, the default is False.

Change-Id: I21133052c67fcd995c3ba11d996b414defcf910a
2016-11-01 18:12:29 -04:00
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
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
Ha Van Tu 5e8f66d152 Remove unused parameters
This patch removes some parameters which are in parameters.yaml but
are not used in other *.inc files.

Change-Id: I53bfb618895a87305eeac6807f62ff1c2f2418cc
2016-09-20 12:02:00 +07: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 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 b624bec672 Merge "Complete verification for os-virtual-interfaces" 2016-09-19 08:45:38 +00: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
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 04e94df911 Merge "Fix api-ref doc for server-rebuild" 2016-09-14 15:31:47 +00:00
Jenkins d3c9c476fc Merge "Complete verification for os-cloudpipe.inc" 2016-09-14 11:46:13 +00: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
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
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
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
Jenkins 32c583ebe7 Merge "Api-ref: Improve os-migrateLive input parameters" 2016-08-30 13:01:00 +00:00
Pushkar Umaranikar d6d41bf888 Api-ref: Improve os-migrateLive input parameters
Modified type of block_migration from input params
of os-migrateLive API based on API version 2.25

Change-Id: I82c6537d137b462dbe6d05c07a9b3afb5a1501d5
Closes-Bug: #1551782
2016-08-30 11:35:30 +00:00
panbalag e0d6e46b52 Added min_version field to 'host_status' in 'api-ref'
Change-Id: I137b99a3e0da1a72151a13c0a21ce9172e57ac8b
2016-08-19 15:19:32 -04:00
Balazs Gibizer 9d08e805a8 doc: fix disk=0 use case in flavor doc
The 0 value of the disk parameter of the flavor is only meaningfull
if the instance is booted from volume as in any other case the
instance will use local disk and the scheduler will not be
able to select the hosts based on the real image size as that
information is not available for the scheduler.

Change-Id: I6b3ba2fb323341071eae6b9e9f54ef833fdbaff7
Closes-Bug: #1599787
DocImpact: admin guide
2016-08-18 08:53:52 +00:00
Matt Riedemann d727795d66 Add REST API support for get me a network
This adds the 2.37 microversion to the REST API for automatically
allocating a network, i.e. get me a network.

The majority of the changes to the REST API concern request
validation. 'networks' is now required in the server POST body
after this microversion. The 'auto' or 'none' special network
uuid values are used, but if specified, can not be specified
with any other requested network values.

The other special case that is checked is when the minimum
compute service version is not new enough to support this change,
i.e. a Mitaka compute will not have the network API code that
knows how to deal with the special auto/none network IDs. Because
the REST API is checking the service version, the service caches
the service version after the first check. Once all computes are
updated to Newton then a restart of the nova-api service(s) will
be required to flush the cache. A release note is provided for
this situation.

The api-ref docs are also updated for this microversion including
an example API sample request.

The matching Tempest change to test this is here:

I89b18709e0cfbbcbf9be96a91a13a1356cdf85b0

The matching python-novaclient change is here:

I6636ddcd3be7bf393d2d69cc6c1ba5c7d65ff674

Implements blueprint get-me-a-network

Change-Id: I89b18709e0cfbbcbf9be96a91a13a1356cdf85b0
2016-08-15 14:10:42 -04:00