Fix parameter types and the order of parameters.
Add missing parameters.
Add a period at the end of a parameter description.
Replace sample files with v2.10 files.
Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302
Closes-Bug: #1656781
Sphinx 1.5 is more picky about highlighting and currently building of
api-ref fails with:
Warning, treated as error:
/home/aj/Software/vcs/OpenStack/openstack/nova/api-ref/source/index.rst:4:
WARNING: Could not lex literal_block as "json". Highlighting skipped.
Fix problems found:
Remove duplicate "progress: 0" from
os-rescue/server-get-resp-unrescue.json,
os-server-tags/v2.26/servers-tags-details-resp.json,
os-server-tags/v2.26/server-tags-show-details-resp.json.
Change json to javascript for highlighting of delete_info.
Change-Id: I7cd969fb4c9d4bff995c34725cfb739cccaba12c
tags already documented in api-ref and we already had all
server queries there, so no additional steps for it
part of bp:api-ref-in-rst-pike
Change-Id: I726171f256a3404801a7f9b8109d46bf5b7c62cf
All the network proxy APIs were deprecated in Newton.
The related quotas have been filtered out in quotas APIs
since I7311ad726f5ca50f5648a539b03c00e712235834.
And they have also been filtered out in limits API
since I00bad055847adbbe26fe2f9225a4adde18f546b8.
But the API reference has not been updated yet.
So fix it.
Change-Id: Ie06585ab572cf6278a580bd3fdb1e86cbd0bcb7a
Closes-Bug: #1654167
The volume_attach case was documented properly but the nova boot
case missed the note after I76a7cfd995db6c04f7af48ff8c9acdd55750ed76
was merged.
Change-Id: I1aa0518e60e349ad625ac366f7748ba35806c829
Closes-Bug: #1664509
There was a typo in the description of this parameter
and it also didn't read very clearly, so I've just
re-written the description of this.
On a side note, it's a bit odd that this is a required
parameter in the response (Tempest requires it in the
response schema) even though it's only set if the
action failed.
Change-Id: Ic84031119e2ffb6b1fb0b0a193967b2823464651
When creating a flavor you do not actually have to
provide an id. If one is not provided in the request,
an id is automatically generated from a uuid when
creating the flavor. This updates the api-ref to
point that out.
Change-Id: Ie3c7042bd5f1ae05ad4e4eeba078f82c5e23d33a
Closes-Bug: #1663389
When listing servers, it's possible to filter servers based on
the tenant_id. This patch documents this.
Change-Id: I8432aa922cb61ef052cd1f7436546e69d7b6aceb
In the context of device tagging, bugs have caused the tag attribute
to disappear starting with version 2.33 for block_devices and starting
with version 2.37 for network interfaces. In other words, block
devices could only be tagged in 2.32 and network interfaces between
2.32 and 2.36 inclusively.
This patch documents this behaviour in api-ref and introduces
microversion 2.42, which re-adds the tag in all the right places.
Change-Id: Ia0869dc6f7f5bd347ccbd0930d1d668d37695a22
Closes-bug: 1658571
Implements: blueprint fix-tag-attribute-disappearing
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
In "Get Availability Zone Information",
the 'hosts' response parameter is always 'null'.
So fix the description.
Change-Id: I23bd8b3a422aa03c3f56d7f2f10f6603acd0078a
Closes-Bug: #1654427
The type of 'quota_set' is changed to 'object'.
Add a missing response description of DELETE method.
Change-Id: I0a51861c68866303734a1d161b85689e1a3ba636
Closes-Bug: #1653897
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
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
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
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
The 'policies' parameter for the os-server-groups API is an array
for legacy reasons, but the schema validation allows only a single
item and it's from the enumerated list, and exactly one must be
specified when creating a server group.
This patch cleans up the policies parameter description to avoid
confusion over the number of items that can be specified or their
form, and it also provides a description of each available policy.
Since the jsonschema for policies is a bit confusing too, this
patch adds a comment in the schema code to avoid future confusion
over how the validation works.
Change-Id: I3ab2880ed6e8bb2cdf476c197719b83d768d44d0
Closes-Bug: #1652943
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
Jenkins