openstack
/
nova
Code Issues Proposed changes
nova/api-ref/source
History
Matt Riedemann 268190b252 api-ref: explain aggregate set_metadata semantics 
This came up as a source of confusion while reviewing
change Ic27195e46502067c87ee9c71a811a3ca3f610b73 because
I thought that the "metadata" key in the
POST /os-aggregates/{aggregate_id}/action (set_metadata)
API was an overwrite of the existing metadata rather than
an update.

The way the Aggregate.update_metadata() method works is that
new entries are added, existing metadata is updated if the
value is not None, otherwise existing entries are removed
if the value is None.

And because of the AggregateAPI.is_safe_to_update_az() method
the special "availability_zone" metadata cannot be unset to None
once it is set. So the only way to remove an AZ is to delete the
aggregate altogether.

This updates the API reference description of the "metadata"
parameter in the "set_metadata" action API.

Change-Id: I6fa9f9691b945b5212b7f951ab0a26b4d3049df9
Related-Bug: #1378904
 		2019-03-01 12:36:42 -05:00
..
conf.py trivial: Remove crud from 'conf.py' 2018-01-18 10:39:24 +00:00
diagnostics.inc Fixed some nits for microversion 2.48 2017-06-06 13:34:17 +00:00
extensions.inc Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
flavors.inc api-ref: Remove unnecessary minimum microversion 2018-10-25 16:37:21 +09:00
images.inc Fix api-ref: nova image-meta is deprecated from 2.39 2018-03-26 06:31:20 +00:00
index.rst api-ref: mark os-cells as deprecated 2019-02-13 13:19:06 -05:00
ips.inc API Ref: update server_id params 2016-11-11 14:01:51 -05:00
limits.inc api-ref: sort parameters for limits, quotas and quota classes 2017-12-18 13:40:13 -05:00
metadata.inc Make metadata doc more readable 2017-03-31 06:19:01 +00:00
os-agents.inc api-ref: body verification of os-agents 2016-07-08 02:03:07 +00:00
os-aggregates.inc api-ref: mention policy defaults for aggregates 2019-02-06 16:18:24 -05:00
os-assisted-volume-snapshots.inc libvirt: remove glusterfs volume driver 2017-05-19 14:51:42 -04:00
os-availability-zone.inc Fix broken URLs 2017-09-07 15:42:31 +02:00
os-baremetal-nodes.inc Better wording for micorversion 2.36 2016-12-10 18:49:13 +08:00
os-cells.inc api-ref: mark os-cells as deprecated 2019-02-13 13:19:06 -05:00
os-certificates.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-cloudpipe.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-consoles.inc Add description for /consoles 2017-03-29 01:37:56 +08:00
os-fixed-ips.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-flavor-access.inc Verify project id for flavor access calls 2017-05-04 18:23:17 -04:00
os-flavor-extra-specs.inc api-ref: fix link to flavor extra specs docs 2019-02-06 14:49:18 -05:00
os-floating-ip-dns.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-floating-ip-pools.inc Update API reference for os-floating-ip-pools 2018-06-26 09:47:23 -04:00
os-floating-ips-bulk.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-floating-ips.inc api-ref: Fix wrong bold decoration 2018-09-25 16:06:57 +09:00
os-fping.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-hosts.inc Update the documentation links 2017-11-28 11:07:36 +08:00
os-hypervisors.inc update the description of hypervisor statistics response 2018-02-05 22:32:54 -05:00
os-instance-actions.inc Resource retrieving: add changes-before filter 2018-09-19 09:56:56 -04:00
os-instance-usage-audit-log.inc api-ref: Fix description of os-instance-usage-audit-log 2016-12-14 11:22:50 -05:00
os-interface.inc Add microversion to expose virtual device tags 2019-02-21 13:38:51 +00:00
os-keypairs.inc api-ref: Fix keypair API parameters 2017-03-10 15:58:06 +09:00
os-migrations.inc api-ref: Add a description about sort order 2018-11-09 23:56:56 +00:00
os-networks.inc Repair links in Nova documentation 2017-05-23 17:17:52 +07:00
os-quota-class-sets.inc api-ref: sort parameters for limits, quotas and quota classes 2017-12-18 13:40:13 -05:00
os-quota-sets.inc api-ref: sort parameters for limits, quotas and quota classes 2017-12-18 13:40:13 -05:00
os-security-group-default-rules.inc Better wording for micorversion 2.36 2016-12-10 18:49:13 +08:00
os-security-group-rules.inc Complete the api-ref of security group rule 2018-07-12 07:12:20 +00:00
os-security-groups.inc Add 'all_tenants' for GET sec group api ref 2017-11-28 05:37:15 +00:00
os-server-external-events.inc enhance api-ref for os-server-external-events 2017-09-15 06:19:49 +08:00
os-server-groups.inc Add microversion info in the os-server-groups API samples 2018-08-07 22:47:44 +00:00
os-server-password.inc API Ref: update server_id params 2016-11-11 14:01:51 -05:00
os-server-tags.inc api-ref: Remove unnecessary minimum microversion 2018-10-25 16:37:21 +09:00
os-services.inc API microversion 2.69: Handles Down Cells Documentation 2019-02-20 10:10:50 -08:00
os-simple-tenant-usage.inc Merge "api-ref: microversion 2.40 overview" 2017-01-06 13:20:10 +00:00
os-tenant-network.inc Repair links in Nova documentation 2017-05-23 17:17:52 +07:00
os-virtual-interfaces.inc Remove "DEPRECATED" tag from Obsolete APIs 2018-07-18 22:23:45 -04:00
os-volume-attachments.inc Add microversion to expose virtual device tags 2019-02-21 13:38:51 +00:00
os-volumes.inc Repair links in Nova documentation 2017-05-23 17:17:52 +07:00
parameters.yaml api-ref: explain aggregate set_metadata semantics 2019-03-01 12:36:42 -05:00
request-ids.inc api-ref: Add X-Openstack-Request-Id description 2017-07-10 14:03:14 +00:00
server-migrations.inc Fix up force live migration completion docs 2018-12-14 15:13:59 -05:00
server-security-groups.inc api-ref: Fix parameters in server-security-groups 2017-07-10 14:02:13 +00:00
servers-action-console-output.inc Fix 'server' and 'instance' occurrence in api-ref 2017-03-28 02:54:11 +00:00
servers-action-crash-dump.inc remove /v2.1/{tenant_id} from all urls 2016-06-03 08:47:33 -04:00
servers-action-deferred-delete.inc remove /v2.1/{tenant_id} from all urls 2016-06-03 08:47:33 -04:00
servers-action-evacuate.inc API: Remove evacuate/live-migrate 'force' parameter 2019-02-08 17:05:19 -05:00
servers-action-fixed-ip.inc Deprecate Multinic, floatingip action and os-virtual-interface API 2017-04-25 12:04:05 -04:00
servers-action-remote-consoles.inc api-ref: Complete all the verifications of remote consoles 2017-03-23 10:51:13 +08:00
servers-action-shelve.inc api-ref: fix unshelve asynchronous postconditions typo 2017-06-19 09:24:52 -04:00
servers-actions.inc Adds the server group info into show server detail API. 2019-02-28 14:22:46 -05:00
servers-admin-action.inc API: Remove evacuate/live-migrate 'force' parameter 2019-02-08 17:05:19 -05:00
servers-remote-consoles.inc Fix typo 2017-07-13 11:40:43 +08:00
servers.inc Adds the server group info into show server detail API. 2019-02-28 14:22:46 -05:00
urls.inc [api-ref] Minor text clean-up, formatting 2016-11-29 12:31:46 -05:00
versions.inc Fix version details API does not return 200 OK 2018-11-08 16:03:33 +08:00