nova/doc/api_samples
Surya Seetharaman c541ace518 Microversion 2.73: Support adding the reason behind a server lock
This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.

The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action``  where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.

The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.

Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.

Implements blueprint add-locked-reason

Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
2019-05-11 21:48:27 +00:00
..
consoles Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
extension-info "nova list-extensions" not showing summary for all 2016-07-26 16:45:30 +00:00
flavor-access Enable all extension for Flavor API sample tests 2016-06-09 10:25:21 +09:00
flavor-extra-specs Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
flavor-manage Add microversion to support extra_specs in flavor API. 2018-04-11 17:47:57 +08:00
flavors Scrub hw:cpu_model from API samples 2018-08-02 16:00:45 -04:00
images Transform compute_task notifications 2018-11-21 16:23:28 +09:00
keypairs Simple tenant usage pagination 2016-12-14 03:33:50 +00:00
limits Deprecate file injection 2017-12-12 09:22:21 -05:00
os-admin-actions Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-admin-password Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-agents api-ref: Example verification for os-agents.inc 2016-06-27 21:29:26 +09:00
os-aggregates Revert "Revert "Fix AZ related API docs"" 2017-09-10 13:51:47 -06:00
os-assisted-volume-snapshots Fix wrong JSON format in API samples 2016-07-08 10:15:29 +09:00
os-attach-interfaces Add microversion to expose virtual device tags 2019-02-21 13:38:51 +00:00
os-availability-zone Stop using "nova" in API samples when creating a server 2019-03-01 10:43:08 -05:00
os-baremetal-nodes Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-cells Remove '/os-cells' REST APIs 2019-04-16 18:26:13 +01:00
os-certificates Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-cloudpipe Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-console-auth-tokens Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-console-output Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-create-backup 2.45: Remove Location header from createImage and createBackup responses 2017-04-25 15:52:14 -04:00
os-deferred-delete Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-evacuate Fix the api sample docs for microversion 2.68 2019-02-27 16:25:16 +01:00
os-fixed-ips Drop the use of magic openstack project_id 2016-03-08 19:34:56 +00:00
os-floating-ip-dns Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-floating-ip-pools Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-floating-ips Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-floating-ips-bulk Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-fping Drop the use of magic openstack project_id 2016-03-08 19:34:56 +00:00
os-hosts replace chance with filter scheduler in func tests 2017-08-16 14:42:51 +00:00
os-hypervisors Proper error handling by _ensure_resource_provider 2017-11-30 18:30:49 +00:00
os-instance-actions Resource retrieving: add changes-before filter 2018-09-19 09:56:56 -04:00
os-instance-usage-audit-log api-ref: Improve os-instance_usage_audit_log samples 2016-06-21 20:30:11 +09:00
os-lock-server Microversion 2.73: Support adding the reason behind a server lock 2019-05-11 21:48:27 +00:00
os-migrate-server API: Remove evacuate/live-migrate 'force' parameter 2019-02-08 17:05:19 -05:00
os-migrations api-ref: Replace non UUID string with UUID 2018-10-09 14:56:35 +09:00
os-multinic api-ref: Fix examples for add/removeFixedIp action 2017-05-15 01:19:54 +00:00
os-multiple-create Enable all extension for remaining server API tests 2016-06-09 08:53:32 -04:00
os-networks Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
os-networks-associate Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-pause-server Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-preserve-ephemeral-rebuild Enable all extension for remaining server API tests 2016-06-09 08:53:32 -04:00
os-quota-class-sets Deprecate file injection 2017-12-12 09:22:21 -05:00
os-quota-sets Deprecate file injection 2017-12-12 09:22:21 -05:00
os-quota-sets-noop Add API and nova-manage tests that use the NoopQuotaDriver 2017-12-08 22:11:24 +00:00
os-remote-consoles Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-rescue Stop using "nova" in API samples when creating a server 2019-03-01 10:43:08 -05:00
os-security-group-default-rules Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-security-groups Use plain routes list for os-security-group-rules instead of stevedore 2017-07-12 20:58:26 +08:00
os-server-diagnostics Standardization of VM diagnostics info API. 2017-06-05 07:45:51 +00:00
os-server-external-events Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-server-groups Microversion 2.64 - Use new format policy in server group 2018-07-13 10:43:42 +08:00
os-server-password Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-server-tags/v2.26 Stop using "nova" in API samples when creating a server 2019-03-01 10:43:08 -05:00
os-services API microversion 2.69: Handles Down Cells 2019-02-15 14:39:20 -05:00
os-shelve Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-simple-tenant-usage Fix os-simple-tenant-usage result order 2018-10-26 14:47:52 +00:00
os-suspend-server Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-tenant-networks Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
os-virtual-interfaces Expose VIF net-id attribute in os-virtual-interfaces 2015-08-27 16:50:44 +09:00
os-volumes Add microversion to expose virtual device tags 2019-02-21 13:38:51 +00:00
server-ips Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
server-metadata Move the v2 api_sample functional tests 2015-08-18 15:25:41 +08:00
server-migrations Fix ServerMigrationSampleJsonTests to use sample files from version dir 2018-07-19 05:13:24 +00:00
servers Microversion 2.73: Support adding the reason behind a server lock 2019-05-11 21:48:27 +00:00
servers-sort Drop the use of magic openstack project_id 2016-03-08 19:34:56 +00:00
versions Microversion 2.73: Support adding the reason behind a server lock 2019-05-11 21:48:27 +00:00