From 57458276a9dc5bf7c074ee776385425d1e799889 Mon Sep 17 00:00:00 2001 From: bria4010 Date: Mon, 25 Jul 2016 10:24:55 -0400 Subject: [PATCH] api-ref: Refresh images schemas The schemas in the current api-ref are outdated. This patch adds the schemas contained in the 13.0.0.0b2 release. Change-Id: I45615e049339b3df8d1c6cda74d7408a177aba4e Closes-bug: #1606250 --- .../schemas-image-member-show-response.json | 1 + .../schemas-image-members-list-response.json | 1 + .../samples/schemas-image-show-response.json | 48 +++++++++++++------ .../samples/schemas-images-list-response.json | 48 +++++++++++++------ 4 files changed, 68 insertions(+), 30 deletions(-) diff --git a/api-ref/source/v2/samples/schemas-image-member-show-response.json b/api-ref/source/v2/samples/schemas-image-member-show-response.json index 5ad359d7d6..146cc22deb 100644 --- a/api-ref/source/v2/samples/schemas-image-member-show-response.json +++ b/api-ref/source/v2/samples/schemas-image-member-show-response.json @@ -15,6 +15,7 @@ "type": "string" }, "schema": { + "readOnly": true, "type": "string" }, "status": { diff --git a/api-ref/source/v2/samples/schemas-image-members-list-response.json b/api-ref/source/v2/samples/schemas-image-members-list-response.json index 56a160266d..41aa5ade1c 100644 --- a/api-ref/source/v2/samples/schemas-image-members-list-response.json +++ b/api-ref/source/v2/samples/schemas-image-members-list-response.json @@ -25,6 +25,7 @@ "type": "string" }, "schema": { + "readOnly": true, "type": "string" }, "status": { diff --git a/api-ref/source/v2/samples/schemas-image-show-response.json b/api-ref/source/v2/samples/schemas-image-show-response.json index 52279a8358..e8fb4dc3e1 100644 --- a/api-ref/source/v2/samples/schemas-image-show-response.json +++ b/api-ref/source/v2/samples/schemas-image-show-response.json @@ -24,8 +24,9 @@ "type": "string" }, "checksum": { - "description": "md5 hash of image contents. (READ-ONLY)", + "description": "md5 hash of image contents.", "maxLength": 32, + "readOnly": true, "type": [ "null", "string" @@ -40,7 +41,8 @@ "aki", "bare", "ovf", - "ova" + "ova", + "docker" ], "type": [ "null", @@ -48,11 +50,13 @@ ] }, "created_at": { - "description": "Date and time of image registration (READ-ONLY)", + "description": "Date and time of image registration", + "readOnly": true, "type": "string" }, "direct_url": { - "description": "URL to access the image file kept in external store (READ-ONLY)", + "description": "URL to access the image file kept in external store", + "readOnly": true, "type": "string" }, "disk_format": { @@ -75,7 +79,8 @@ ] }, "file": { - "description": "(READ-ONLY)", + "description": "An image file url", + "readOnly": true, "type": "string" }, "id": { @@ -84,7 +89,7 @@ "type": "string" }, "instance_uuid": { - "description": "ID of instance used to create this image.", + "description": "Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)", "is_base": false, "type": "string" }, @@ -92,7 +97,10 @@ "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", "is_base": false, "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string" + "type": [ + "null", + "string" + ] }, "locations": { "description": "A set of URLs to access the image file kept in external store", @@ -156,33 +164,41 @@ "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", "is_base": false, "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string" + "type": [ + "null", + "string" + ] }, "schema": { - "description": "(READ-ONLY)", + "description": "An image schema url", + "readOnly": true, "type": "string" }, "self": { - "description": "(READ-ONLY)", + "description": "An image self url", + "readOnly": true, "type": "string" }, "size": { - "description": "Size of image file in bytes (READ-ONLY)", + "description": "Size of image file in bytes", + "readOnly": true, "type": [ "null", "integer" ] }, "status": { - "description": "Status of the image (READ-ONLY)", + "description": "Status of the image", "enum": [ "queued", "saving", "active", "killed", "deleted", - "pending_delete" + "pending_delete", + "deactivated" ], + "readOnly": true, "type": "string" }, "tags": { @@ -194,11 +210,13 @@ "type": "array" }, "updated_at": { - "description": "Date and time of the last image modification (READ-ONLY)", + "description": "Date and time of the last image modification", + "readOnly": true, "type": "string" }, "virtual_size": { - "description": "Virtual size of image in bytes (READ-ONLY)", + "description": "Virtual size of image in bytes", + "readOnly": true, "type": [ "null", "integer" diff --git a/api-ref/source/v2/samples/schemas-images-list-response.json b/api-ref/source/v2/samples/schemas-images-list-response.json index 2d148eb939..f3f317541b 100644 --- a/api-ref/source/v2/samples/schemas-images-list-response.json +++ b/api-ref/source/v2/samples/schemas-images-list-response.json @@ -45,8 +45,9 @@ "type": "string" }, "checksum": { - "description": "md5 hash of image contents. (READ-ONLY)", + "description": "md5 hash of image contents.", "maxLength": 32, + "readOnly": true, "type": [ "null", "string" @@ -61,7 +62,8 @@ "aki", "bare", "ovf", - "ova" + "ova", + "docker" ], "type": [ "null", @@ -69,11 +71,13 @@ ] }, "created_at": { - "description": "Date and time of image registration (READ-ONLY)", + "description": "Date and time of image registration", + "readOnly": true, "type": "string" }, "direct_url": { - "description": "URL to access the image file kept in external store (READ-ONLY)", + "description": "URL to access the image file kept in external store", + "readOnly": true, "type": "string" }, "disk_format": { @@ -96,7 +100,8 @@ ] }, "file": { - "description": "(READ-ONLY)", + "description": "An image file url", + "readOnly": true, "type": "string" }, "id": { @@ -105,7 +110,7 @@ "type": "string" }, "instance_uuid": { - "description": "ID of instance used to create this image.", + "description": "Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)", "is_base": false, "type": "string" }, @@ -113,7 +118,10 @@ "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", "is_base": false, "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string" + "type": [ + "null", + "string" + ] }, "locations": { "description": "A set of URLs to access the image file kept in external store", @@ -177,33 +185,41 @@ "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", "is_base": false, "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string" + "type": [ + "null", + "string" + ] }, "schema": { - "description": "(READ-ONLY)", + "description": "An image schema url", + "readOnly": true, "type": "string" }, "self": { - "description": "(READ-ONLY)", + "description": "An image self url", + "readOnly": true, "type": "string" }, "size": { - "description": "Size of image file in bytes (READ-ONLY)", + "description": "Size of image file in bytes", + "readOnly": true, "type": [ "null", "integer" ] }, "status": { - "description": "Status of the image (READ-ONLY)", + "description": "Status of the image", "enum": [ "queued", "saving", "active", "killed", "deleted", - "pending_delete" + "pending_delete", + "deactivated" ], + "readOnly": true, "type": "string" }, "tags": { @@ -215,11 +231,13 @@ "type": "array" }, "updated_at": { - "description": "Date and time of the last image modification (READ-ONLY)", + "description": "Date and time of the last image modification", + "readOnly": true, "type": "string" }, "virtual_size": { - "description": "Virtual size of image in bytes (READ-ONLY)", + "description": "Virtual size of image in bytes", + "readOnly": true, "type": [ "null", "integer"