With cells v2, we need to be clear about what is cells v1 and
what is cells v2 in our documentation. This makes a note in the
os-cells api-ref about that being for cells v1 and also adds a
line saying the entire API is admin-only by default.
Change-Id: I2a06e2c4921ce7172aab33818054dd37b5ef9a65
Found that docs about server metadata is quite
hard to understand, made some modifications to
be more readable.
Change-Id: If74dc383149068f2c568482c78e6db1e19f7d3af
* POST /servers
The 413 response code has not been expected
since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
So remove 413.
* POST /server/{server_id}/action
In 'Rebuild' action, the 413 response code has not been expected
since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
So remove 413.
In 'Rescue' action, the normal response code is actually 200
instead of 202.
So fix it.
Change-Id: I6e91d3ac751777f48ab084395a66cb3f83bfcca2
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1677452
This commit fix the below doc issue for adminPass
-'adminPass' attrbiure is only return in response if
'enable_instance_password' configuration option is set to true
- evacuate API stop returning adminPass from 2.14 microversion
so max version for this field is 2.13.
- if 'adminPass' is not present in request then, operation auto generate one.
Change-Id: I636657ed30b33da0a2df73b222c4ce5d8388a3d8
some api-ref have sentence like '..for a server instance'
which is inconsistent and confusing as we use server for VM terminology.
I think here 'instance' word is being considered object of server which
is wrong.
We should always mention server only.
part of bp:api-ref-in-rst-pike
Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
The description of the volumeAttachment request parameter was actually
the description of the response parameter, which included more fields
than we allow on the POST and PUT requests for os-volume_attachments.
This fixes the descriptions for both POST and PUT and also includes a
tiny fix for the wording on the existing volumeAttachment parameter.
Change-Id: I4ccd4ac12e24b232925875fdb5fb568c2bfaf417
Closes-Bug: #1675536
This patch includes all the verifications of remote consoles
part of blueprint api-ref-in-rst-pike
Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com>
Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c
The current descriptions for hostId, host, and hypervisor_hostname are
vague, so this adds more detail to make them more understandable.
Closes-Bug: #1673593
Change-Id: Id3ea9bbfe59a47b24e3584cf16b5a556007e58ea
Add api-ref doc for the filter/sort whitelist,
showing what can be used to filter and
sort results when calling list server API.
Co-Authored-By: ghanshyam <ghanshyammann@gmail.com>
Change-Id: I821085f885f207408e56f73ccbf0956dc017ba78
The services data model and API is not per-tenant, it's
per-region, so this change updates the docs to reflect that.
Change-Id: I45bc0bd5afcd05626f61be84c012e00f723f80eb
The original changed description tried to explain the instance
data still exists after the API operation, but that was not clear.
This patch makes it clear as possible for users.
In addition, this patch removes the related sentence of os-start
to avoid the same confusion.
Change-Id: I46c4d24a67717807f4c6650a739f7855108783e9
snapshot action nova will return image URL in response header
better to provide this info to end user for their reference.
Also, the backup header description is changed as well.
Change-Id: I15cf228b4a5a2d0dbae5fa76ec6821487e7808ed
Closes-Bug: 1657998
- The type of aggegate ID is changed to 'integer' instead of 'string'.
- The uuid of aggegate is changed to 'required'
because the uuid is always shown in the response after v2.41.
- The response examples are replaced with v2.41 examples.
Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80
Closes-Bug: #1659475
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
Matt Riedemann