From 345b9e77fe98b25d26b339a04e6530541a2c4db6 Mon Sep 17 00:00:00 2001 From: zhangbailin Date: Tue, 27 Nov 2018 20:36:00 -0500 Subject: [PATCH] Add description to common image properties Add the 'description' attribute to common image properties to allow users to record the purpose of the image in a human-readable format in an interoperable way. Co-authored-by: zhangbailin Co-authored-by: Brian Rosmaita Change-Id: Id0b148190cfa5fb9851ad2085a6b1ac1e0e7e352 Blueprint: add-description-field-to-image --- doc/source/user/common-image-properties.rst | 6 ++++++ etc/schema-image.json | 6 +++++- ...ription-common-image-property-95ab1139d41579d2.yaml | 10 ++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 releasenotes/notes/add-description-common-image-property-95ab1139d41579d2.yaml diff --git a/doc/source/user/common-image-properties.rst b/doc/source/user/common-image-properties.rst index 47f7c87c55..845c170df9 100644 --- a/doc/source/user/common-image-properties.rst +++ b/doc/source/user/common-image-properties.rst @@ -60,3 +60,9 @@ https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html -------------- The operating system version as specified by the distributor. + +**description** +--------------- + +A brief human-readable string, suitable for display in a user interface, +describing the image. diff --git a/etc/schema-image.json b/etc/schema-image.json index dcd802d42e..2c859a2549 100644 --- a/etc/schema-image.json +++ b/etc/schema-image.json @@ -22,7 +22,11 @@ "type": "string" }, "os_version": { - "description": "Operating system version as specified by the distributor", + "description": "Operating system version as specified by the distributor.", + "type": "string" + }, + "description": { + "description": "A human-readable string describing this image.", "type": "string" } } diff --git a/releasenotes/notes/add-description-common-image-property-95ab1139d41579d2.yaml b/releasenotes/notes/add-description-common-image-property-95ab1139d41579d2.yaml new file mode 100644 index 0000000000..64f7845941 --- /dev/null +++ b/releasenotes/notes/add-description-common-image-property-95ab1139d41579d2.yaml @@ -0,0 +1,10 @@ +--- +features: + - | + A new common image property, 'description', has been added. This + allows you to specify a brief human-readable description, suitable + for display in a user interface, on images. It has been possible + to do this previously using a custom image property; this change + simply standardizes the usage in order to promote interoperability. + This change has no effect on any property named 'description' on + existing images, and it is not a required image property.