diff options
| author | Dan Smith <dansmith@redhat.com> | 2021-01-18 09:28:37 -0800 |
|---|---|---|
| committer | Dan Smith <dansmith@redhat.com> | 2021-01-25 12:30:50 -0800 |
| commit | 07951b095b31c8325f6c8fb8c19c641bb6667937 (patch) | |
| tree | 47f3a0d5891b3a07873a4acf89d9da09f8c4ff6e /api-ref | |
| parent | 0c45de3ed8253096bb9d4031db8e046107e2774b (diff) | |
| download | glance-07951b095b31c8325f6c8fb8c19c641bb6667937.tar.gz | |
Update docs and renos for os_glance reservation
This adds some words to the api-ref doc, as well as a release note
about the blanket reservation of os_glance* properties.
Change-Id: I0cd6f35296a647fdb1f2cb44a688b34c0382c556
Related-Bug: #1912001
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/v2/images-images-v2.inc | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/api-ref/source/v2/images-images-v2.inc b/api-ref/source/v2/images-images-v2.inc index 54a3788ea..1570fa001 100644 --- a/api-ref/source/v2/images-images-v2.inc +++ b/api-ref/source/v2/images-images-v2.inc @@ -42,6 +42,10 @@ Here's some important information about image properties: situation of the image (which, in turn, indicates what you can do with the image), and its *visibility*, which indicates who has access to the image. +* Some properties are used internally by glance and API users are not + allowed to set or modify them. Examples of these are *id*, *status*, + and anything prefixed with the *os_glance* namespace. + .. note:: In addition to image properties, there's usually a data payload that is accessible via the image. In order to give image consumers some guarantees @@ -191,7 +195,7 @@ Request Additionally, you may include additional properties specified as key:value pairs, where the value must be a string data type. Keys are limited to 255 chars in length. Available key names may be limited by the cloud's -property protection configuration. +property protection configuration and reserved namespaces like *os_glance*. Request Example --------------- @@ -563,6 +567,9 @@ fail with a 403 (Forbidden) response code: - An attempt to delete the only image location, or to replace the image locations with an empty list *(since Image API v2.4)*. +- An attempt to set or modify a property with a reserved name, such as + anything prefixed with the *os_glance* namespace. + Attempting to add a location path to an image that is not in ``queued`` or ``active`` state will result in a 409 (Conflict) response code *(since Image API v2.4)*. |