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
This includes the parameter, body, and example verifications for
api-ref servers-action-fixed-ip.
part of bp:api-ref-in-rst-pike
Change-Id: I2b9971d7ff3716f330b55020bf37489dbc9e9b2c
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
several params like metadata_xxx are used and actually they are
same, so just clean up them and use metadata_object instead
part of bp:api-ref-in-rst-pike
Change-Id: I455c02b5dcd77df43fc8c0113269f71a5207d3d5
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
Apparently we thought it was useful to tell you that
while a server is being deleted you could watch it's
status, but not enough that we cared to tell you what
status.
Change-Id: Ibb175c448712cbc0ff80353b83dcab524b223e4d
Closes-Bug: #1663036
When listing servers, it's possible to filter servers based on
the tenant_id. This patch documents this.
Change-Id: I8432aa922cb61ef052cd1f7436546e69d7b6aceb
A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.
- os-cells
- os-security-groups
- os-server-groups
- os-snapshots
- os-virtual-interfaces
- os-volume-attachments
- os-volumes
Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a
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
Use the microversion response samples that include the paging links in
the example JSON responses.
Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
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
After microversion 2.35 all of the os-tenant-networks methods will
return a 404 response. However, before that, if using neutron:
- POST will return a 503 error because the NotImplementedError is
caught and translated to the 503.
- DELETE will return a 500 error because the NotImplementedError
is NOT caught so results in a 500.
The API reference only noted that the API is deprecated since the
2.36 microversion but doesn't note that POST and DELETE are not
implemented, so this adds those details for unsuspecting victims.
Change-Id: I7f256a4c1a6e4247698fcb5ee7c56128c517e29b
Closes-Bug: #1652252
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
