From 94cfc6e22143d9d63fb62955b2356aaaa8f4c044 Mon Sep 17 00:00:00 2001 From: Ilya Sviridov Date: Mon, 10 Aug 2015 10:53:28 -0700 Subject: [PATCH] OpenStack Image V2 API documentation Changed None values to null Change-Id: I9e926c9f91004e7631d9ab6d58ad1f85758d22c0 Closes-Bug: #1481512 --- api-ref/src/docbkx/ch_images-v2.xml | 5 ++- api-ref/src/wadls/image-api/src/v2/common.ent | 38 +++++++++---------- .../src/v2/samples/image-create-response.json | 6 +-- .../image-details-deactivate-response.json | 2 +- .../v2/samples/image-details-response.json | 2 +- .../src/v2/samples/image-list-response.json | 4 +- .../src/v2/samples/image-update-response.json | 12 +++--- 7 files changed, 35 insertions(+), 34 deletions(-) diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 0667fc92c..065b95fb0 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -30,8 +30,9 @@ Images Creates, lists, updates, and deletes images. - Image operations show all fields in the response body. For any - field with no value, the response body shows None. + Image operations show all fields in the response body. Any field + with no value is set to null value (JSON null data + type). The possible status values for images are: diff --git a/api-ref/src/wadls/image-api/src/v2/common.ent b/api-ref/src/wadls/image-api/src/v2/common.ent index 5ffc2549e..4fa4b439c 100644 --- a/api-ref/src/wadls/image-api/src/v2/common.ent +++ b/api-ref/src/wadls/image-api/src/v2/common.ent @@ -189,11 +189,9 @@ - Sorts by one or more attribute and sort direction combinations. You can also set multiple sort keys and directions. Default direction is desc. - For example: GET /v2/images?sort=name:asc,status:desc @@ -238,8 +236,8 @@ The name of the image. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -252,8 +250,8 @@ The container format of image. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -274,7 +272,7 @@ The disk format of the image. - If this field has no value, its value is None. + If this field has no value, its value is null (JSON null data type). '> @@ -291,9 +289,11 @@ style="plain" required="true" type="xsd:int"> - The minimum disk size in GB that is required to boot the image. - If this field has no value, its value is None. + The minimum disk size in GB that is required to boot the image. + + + If this field has no value, its value is null (JSON null data type). '> @@ -319,8 +319,8 @@ The minimum amount of RAM in MB that is required to boot the image. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -332,8 +332,8 @@ Hash of the image data used. The Image service uses this value for verification. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -343,8 +343,8 @@ The ID of the owner, or tenant, of the image. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -362,8 +362,8 @@ The virtual size of the image. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> @@ -381,8 +381,8 @@ The size of the image data, in bytes. - If this field has no value, its - value is None. + + If this field has no value, its value is null (JSON null data type). '> diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json index aa679dc39..2b362d3bb 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json @@ -18,7 +18,7 @@ "owner": "b4eedccc6fb74fa8a7ad6b08382b852b", "min_ram": 0, "schema": "/v2/schemas/image", - "size": "None", - "checksum": "None", - "virtual_size": "None" + "size": null, + "checksum": null, + "virtual_size": null } diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-details-deactivate-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-details-deactivate-response.json index 1180fd363..43d41c335 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-details-deactivate-response.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-details-deactivate-response.json @@ -17,5 +17,5 @@ "size": 13167616, "min_ram": 0, "schema": "/v2/schemas/image", - "virtual_size": "None" + "virtual_size": null } diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-details-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-details-response.json index c425508f5..07055355c 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-details-response.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-details-response.json @@ -17,5 +17,5 @@ "size": 13167616, "min_ram": 0, "schema": "/v2/schemas/image", - "virtual_size": "None" + "virtual_size": null } diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-list-response.json index ded242eac..8e2097a09 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-list-response.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-list-response.json @@ -19,7 +19,7 @@ "size": 13167616, "min_ram": 0, "schema": "/v2/schemas/image", - "virtual_size": "None" + "virtual_size": null }, { "status": "active", @@ -40,7 +40,7 @@ "size": 476704768, "min_ram": 0, "schema": "/v2/schemas/image", - "virtual_size": "None" + "virtual_size": null } ], "schema": "/v2/schemas/images", diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-update-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-update-response.json index a360ba5f2..2fdcdd90f 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-update-response.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-update-response.json @@ -14,10 +14,10 @@ "self": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea", "file": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea/file", "schema": "/v2/schemas/image", - "owner": "None", - "min_ram": "None", - "min_disk": "None", - "disk_format": "None", - "virtual_size": "None", - "container_format": "None" + "owner": null, + "min_ram": null, + "min_disk": null, + "disk_format": null, + "virtual_size": null, + "container_format": null }