Commit Graph

207 Commits

Author SHA1 Message Date
Takashi NATSUME 070656a478 api-ref: Fix path parameters in os-hypervisors.inc
The hypervisor ID in path parameters have been fixed to 'integer'.
In "Search Hypervisor" and "List Hypervisor Servers",
the hypervisor IDs have been fixed to a string for searching
hypervisor host names.

Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f
Closes-Bug: #1654197
2017-01-26 23:40:12 +00:00
Jenkins e1b90214c2 Merge "api-ref: Fix parameters whose values are 'null'" 2017-01-19 00:05:24 +00:00
Takashi NATSUME 7c66d4184b api-ref: Fix a parameter in os-availability-zone.inc
In "Get Availability Zone Information",
the 'hosts' response parameter is always 'null'.
So fix the description.

Change-Id: I23bd8b3a422aa03c3f56d7f2f10f6603acd0078a
Closes-Bug: #1654427
2017-01-18 10:02:18 +00:00
Takashi NATSUME 8892be066a api-ref: Fix parameters whose values are 'null'
Replace 'string' type with 'none' type in parameters
whose values are 'null'.

http://lists.openstack.org/pipermail/openstack-dev/2017-January/110009.html

TrivialFix
Change-Id: I4ebcc4db362eaf18560c9d6a6f8c11ecbead4c16
2017-01-16 17:19:51 +09:00
Takashi NATSUME 69f27a7ced api-ref: Fix parameters and response in os-quota-sets.inc
The type of 'quota_set' is changed to 'object'.
Add a missing response description of DELETE method.

Change-Id: I0a51861c68866303734a1d161b85689e1a3ba636
Closes-Bug: #1653897
2017-01-16 00:12:20 +00:00
Jenkins 9b918199d8 Merge "Return uuid attribute for aggregates" 2017-01-07 05:12:18 +00:00
Jenkins f98006f8a4 Merge "correct misleading wording" 2017-01-06 17:48:23 +00:00
jichenjc e4ae7e91dc correct misleading wording
this schema tells us host is required
https://github.com/openstack/nova/blob/master/nova/api/
openstack/compute/schemas/migrate_server.py#L33
and also param say it's required, but the doc says 'if you omit'
will misleading user ,actually, user can't omit it, they need
to input null to let scheduler decide

Implements: blueprint api-ref-in-rst-ocata

Change-Id: I2661c85f32eff8e199856635a4c40a494a5decb6
2017-01-06 14:38:40 +00:00
Jenkins 7083017ab9 Merge "Missing usage next links in api-ref" 2017-01-06 13:11:26 +00:00
Jay Pipes 03c2776e49 Return uuid attribute for aggregates
Adds a Compute API microversion that triggers returning an aggregate's UUID
field. This field is necessary for scripts that must populate the placement API
with resource provider to aggregate relationships, which rely on UUIDs for
global identification.

APIImpact
blueprint: return-uuid-from-os-aggregates-api
Change-Id: I4112ccd508eb85403933fec8b52efd468e866772
Closes-bug: #1652642
2017-01-05 14:32:43 -05:00
Takashi NATSUME 1278b1fe44 api-ref: Fix parameters in os-server-groups.inc
Fix the following parameters.

- 'id'(server group id) defined as a path parameter in body
- 'server_group' object defined as 'server_groups' list
- missing 'server_group' object
- 'user_id' defined as a query parameter in body

Change-Id: I3dcf6aa317b428d6984b0dcb61496594a68bba6f
Closes-Bug: #1652897
2017-01-03 23:29:37 +00:00
Diana Clarke 38a1edf636 Missing usage next links in api-ref
Microversion 2.40 added paging to simple tenant usage, complete with
"next" links, but the api-ref response documentation wasn't updated to
include them.

Change-Id: Iaf2d71cc45b896ccb00271fd455befd24f1efadd
Closes-Bug: #1651254
2017-01-03 08:46:34 -05:00
Jenkins 1015642f41 Merge "Trival fix typos in api-ref" 2017-01-03 09:23:00 +00:00
Takashi NATSUME e7f5f02f7d api-ref: Fix parameter type in servers-admin-action.inc
Fix parameter type and add a missing parameter
in servers-admin-action.inc.

Change-Id: I8ad9227b49ad8148098a8658647bb4a9216d15ba
Closes-Bug: #1651441
2016-12-26 05:30:47 +00:00
Kevin_Zheng 250799551b Trival fix typos in api-ref
Trival fix typos in api-ref

Change-Id: I98347db828a919dd9fa8f3c3ad51c7a048909176
2016-12-21 21:50:55 +08:00
Jenkins f2e4b244e8 Merge "osapi_max_limit -> max_limit" 2016-12-19 15:25:50 +00:00
Diana Clarke c8b631bc36 osapi_max_limit -> max_limit
This max limit config option was moved to the api group in
Ida4ee57d6e1822e35e3198f6d3a89410e211d57d. Update the api-ref to reflect
those changes.

Change-Id: I8ee5b07eecc49833987be499273f3eb7420197e4
2016-12-15 13:28:51 -05:00
Diana Clarke 83404013cb Simple tenant usage pagination
Add optional parameters 'limit' and 'marker' to the
os-simple-tenant-usage endpoints for pagaination.

  /os-simple-tenant-usage?limit={limit}&marker={instance_uuid}
  /os-simple-tenant-usage/{tenant}?limit={limit}&marker={instance_uuid}

The aggregate usage totals may no longer reflect all instances for a
tenant, but rather just the instances for a given page. API consumers
will need to stitch the aggregate data back together (add the totals)
if a tenant's instances span several pages.

Implements blueprint paginate-simple-tenant-usage
Change-Id: Ic8e9f869f1b855f968967bedbf77542f287f26c0
2016-12-14 03:33:50 +00:00
Takashi NATSUME 6ab20bc523 api-ref: Fix 'id' (attachment_id) parameters
At first, the 'attachment_id_resp' in parameters.yaml was defined
as 'required' in I3789a4ad36e30728024f2aa122403b0e53b1e741
for os-volume_attachments.inc.
Then it was changed to 'optional' in
I0c1d183c5aaf6fb796be30fa5627bd5644ea689f
for os-volumes.inc.
So currently 'id' (attachment_id) parameters in
os-volume_attachments.inc are wrong.
They should be 'required'. So fix them.

Change-Id: I403a9eb1b08a840cbb2b82cb37f1b49c6edb87c9
Closes-Bug: #1608842
2016-12-13 06:18:05 +00:00
Jenkins e75d5f9d53 Merge "[proxy-api] microversion 2.39 deprecates image-metadata proxy API" 2016-12-07 21:17:03 +00:00
Pavel Kholkin df6e2d37f2 [proxy-api] microversion 2.39 deprecates image-metadata proxy API
Almost all proxy APIs were deprecated in microversion 2.36.
But the sub-resource image-metadata of image was forgotten to deprecate.
This patch deprecates the image-metdata API from 2.39.

Implements blueprint deprecate-image-meta-proxy-api
Closes-bug: #1614578

Change-Id: I5507337ab6fe4a377f66dec3fe275d75618cd7b4
2016-12-07 19:22:43 +03:00
Jenkins 8dafe05b42 Merge "api-ref: add missing os-server-groups parameters" 2016-11-29 11:30:54 +00:00
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
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