This max limit config option was moved to the api group in
Ida4ee57d6e1822e35e3198f6d3a89410e211d57d. Update the api-ref to reflect
those changes.
Change-Id: I8ee5b07eecc49833987be499273f3eb7420197e4
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
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
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
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
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
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
This includes the parameter, example, and body
verification for os-floating-ips.
part of bp:api-ref-in-rst-ocata
Change-Id: I4beff34b41baf77827a2e4d916ad5319bdefbfa1
This completes the parameter verification for the server-migrations
API.
Partial-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I94ac520b35f4e6a042456c67bc713202fd8c3c91
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
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
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
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
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
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
This patch removes some parameters which are in parameters.yaml but
are not used in other *.inc files.
Change-Id: I53bfb618895a87305eeac6807f62ff1c2f2418cc
Removes trailing '`_' and updates URL to be consistent with rest of
document by providing a full sentence.
Closes Bug: 1621891
Change-Id: Iea47703b624db6de0912abe7ad42a018596d951e
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
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
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
'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
added hypervisor_links into response of hypervisor we need to
add it
Also, verified sample.
Implements: blueprint api-ref-in-rst
Change-Id: I38241f116482a99609e5892a9e20ea5496d89f2b
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
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
This patch verifies the example & parameters of
os-security-group-default-rules.inc
part of bp:api-ref-in-rst
Change-Id: I1e94aad4c9f763c41d921d761c215cc2de03af5a
This patch changes type 'list' to 'array' in server_groups_list because
we don't have 'list' type.
Change-Id: Ibb443ab6f88da7c4cfc53bfbf102c518abaea9ac