The marker for paging over hypervisors (compute nodes) is the
integer id field (compute_nodes.id column). This corrects the
type in the API reference parameters.
Change-Id: If925929171a2d7a1fbd0a8926e550512915c24a3
Closes-Bug: #1696554
Before this patch, VM diagnostics response was just a
'blob' of data returned by each hypervisor. New API
version makes diagnostics response standardized.
New response has a set of fields which each hypervisor
will try to fill. If hypervisor unable to provide a
specific field then this field will be reported as 'None'.
Tempest tests: I7757c5beeea3d3b0bc15a51cafc5ea2ada65e76c
DocImpact: admin guide docs should be updated to mention
standardized version of the diagnostics response
blueprint: restore-vm-diagnostics
Change-Id: If0b1493cc5c1c7f0d9896dd68342ad4dea4f7da2
Add a new microversion to change the flavor field in the server
details to display a subset of the flavor information instead of
just a link to the original flavor.
This is more reliable since it shows the actual instance size, while
the flavor may have been deleted/recreated in the meantime or the
flavor extra-specs may have been modified.
Implements: blueprint instance-flavor-api
Change-Id: If646149efb7eec8c90bf7d07c39ff4c495349941
Artom ruined my day by pointing out that with microversion 2.37
and specifying the enum "auto" for the networks entry in a server
create request, you can't also apply a device tag to the port
that's auto-created for the server.
This change updates the networks API reference parameter description
to note that wrinkle since it's not obvious otherwise without looking
at the API schema.
Change-Id: I1e39aa5a41befb24bb947be060f43f0a96134139
* Example for the rebuild action
The functional test is modified and
the example is replaced with v2.26 examples.
* Example for the rescue action
The example in API reference is replaced with
the example with 'rescue_imgae_ref'.
Parameters for the rebuild action and the rescue action
are also fixed.
The patch completes the parameter verification and
the example verification of servers-actions.inc.
Change-Id: Iaf8808b13d1fdfead50da4cd447b3893578f76dd
Implements: blueprint api-ref-in-rst-pike
This changes the response for the createImage and createBackup
server action APIs to no longer return a Location header and instead
returns a json dict body with the snapshot image ID. This is done
in a new microversion.
Implements blueprint remove-create-image-location-header-response
Closes-Bug: #1679285
Change-Id: Idc899ee76b8265b1c9e0871b6c7c277424cdd442
Fix the description for the 'flavorRef' parameter
in 'Create Server' API.
Change-Id: I6b0eb733961d0b8d28aea9abf2c21734fd07cb42
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1685977
This patch fixes the parameters of the following actions.
* os-start
* os-stop
* suspend
* unlock
* unpause
* unrescue
A subsequent patch will fix the patameters and the examples
of the 'rebuild' and 'rescue' actions in servers-actions.inc.
Change-Id: I8f699c75c5cbfd9046258f593c1437b87dc9c3fe
Implements: blueprint api-ref-in-rst-pike
This patch fixes the parameters of the following actions.
* removeSecurityGroup
* resize
* resume
* revertResize
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: Ie470138ac53404369f4fc717bf979b94060c5652
Implements: blueprint api-ref-in-rst-pike
This patch fixes the parameters of the following actions.
* lock
* pause
* reboot
* removeFloatingIp
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: I33210b5d8cfb359e4cc9ef37fe74b71d30a9acc5
Implements: blueprint api-ref-in-rst-pike
* Unnecessary note is removed.
* The 'on_shared_storage' parameter
The max version is 2.13.
Improve the description.
* The 'evacuate' parameter
Fix the type and the description.
* The 'adminPass' parameter
Fix the description and remove max version.
* The 'host' parameter
Improve the description.
* response code
Remove unncessary response codes.
Add a missing response code.
Change-Id: Ic857333ac25bee26e3ec22106b1b8fda2389b967
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1683264
This patch fixes the parameters of the following actions.
* addSecurityGroup
* changePassword
* confirmResize
* createImage
Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.
Change-Id: Ifaa1ed25c034e649ea4012f4998c571c38d404a1
Implements: blueprint api-ref-in-rst-pike
* Show Host Details
- The parameters in 'resource' object are prefixed
with 'resource.' instead of 'host.'.
- The types of 'cpu', 'memory_mb' and 'disk_gb' are
changed to 'integer'.
- The descriptions of 'cpu', 'memory_mb' and 'disk_gb'
are changed (clearer).
* Update Host status
- The 'status' and 'maintenance_mode' in request
parameters are changed to 'body' parameters
instead of 'path' parameters.
- The 'status' and 'maintenance_mode' in request
parameters are changed to either 'enable' or
'disable'.
- The 'status' and 'maintenance_mode' in response
parameters are changed to 'optional'.
Change-Id: Ic6bffca8b1dfaa9284a72145f3e1f894acb306e3
Closes-Bug: #1653884
There are two main changes here:
1. The contents of the os-extended-volumes:volumes_attached list are
described, which are the id and delete_on_termination keys, the latter
being introduced in the GET /servers response in 2.3.
2. The os-extended-volumes:volumes_attached parameters are removed from
the PUT /servers and POST /servers responses, since we don't actually
include those in the response for create and update operations, only
GET /servers/{server_id} and GET /servers/detail operations.
Note: create server is fixed in a follow up patch.
Change-Id: Ic92055e3095d220a3a11e35628f04e9e67c6b71a
Closes-Bug: #1675559
Since microversion 2.37 networks is mandatory in Create Server
request. This was not reflected in the api-ref. In the Description
field it is explained that the field become mandatory in 2.37 what
is correct, but the optionality should reflect the actual status.
Change-Id: I58ee75df3f1697b34db22469f1dafbe139e05a6b
Signed-off-by: csatari <gergely.csatari@nokia.com>
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
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
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
Matt Riedemann