* 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
create server API only return few elements in response
not all which are currently shown in api-ref.
This commit fix that.
Part of bp/api-ref-in-rst-pike
Change-Id: I782e97bc3ffb1e1c192b5a63736e524917739e4b
The createBackup API does not support backing up volume-backed
instances. The error message the user gets is not useful about
why the request was invalid, and the API reference docs do not
mention the limitation. This change addresses both of those issues.
Change-Id: I04fd8ab4f8818d9d0ccccb6f6fcb34965b15b8f3
Partial-Bug: #1679314
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
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
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>
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