From 85c2de49691c412f367e4e8949fa7150f0b6d27a Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sat, 12 Dec 2015 22:12:30 -0600 Subject: [PATCH] Update Image service API v1 and v2 to spellcheck and make other changes - Remove passive voice from api-site - Renamed api-ref/src/wadls/image-api/src/v1/api_samples to .../samples - Renamed code samples using this naming convention: --request.json or --response.json. For example, volume-create-request.json and volume-create-response.json. - Removed unused code samples - Made method names consistent throughout - use list for list operations, show for show operations, and so on. - csapi:uuid -> csapi:UUID Change-Id: I78189bbab4f50b46c4c146abe5e95bede379dda7 Partial-Bug: #1521244 --- api-ref/src/docbkx/ch_images-v1.xml | 47 ++-- api-ref/src/docbkx/ch_images-v2.xml | 194 ++++++-------- ...ons.json => extensions-list-response.json} | 2 +- api-ref/src/wadls/image-api/src/v1/common.ent | 4 +- ...ps.json => image-members-add-request.json} | 0 ...n => image-memberships-list-response.json} | 0 ...json => images-list-details-response.json} | 0 ...agelist.json => images-list-response.json} | 0 ....json => shared-images-list-response.json} | 0 .../images-v1.wadl} | 114 ++++---- api-ref/src/wadls/image-api/src/v2/common.ent | 24 +- ...ate-req.json => image-create-request.json} | 0 ...response.json => image-show-response.json} | 0 ...ate-req.json => image-update-request.json} | 2 +- ...esponse.json => images-list-response.json} | 0 ... => metadef-namespace-create-request.json} | 0 ... => metadef-namespace-update-request.json} | 0 ... => metadef-namespaces-list-response.json} | 0 ...son => metadef-object-create-request.json} | 0 ...son => metadef-object-update-request.json} | 0 ...son => metadef-objects-list-response.json} | 0 ... => metadef-properties-list-response.json} | 0 ...n => metadef-property-create-request.json} | 0 ...n => metadef-property-update-request.json} | 0 ...def-resource-type-assoc-list-response.json | 17 -- ...metadef-resource-type-create-request.json} | 0 ...metadef-resource-types-list-response.json} | 0 ...q.json => metadef-tag-create-request.json} | 0 ...q.json => metadef-tag-update-request.json} | 0 ...e.json => metadef-tags-list-response.json} | 0 .../v2/samples/schema-image-get-response.json | 67 ----- ...=> schema-image-member-show-response.json} | 0 ...e.json => schema-image-show-response.json} | 0 ...hema-metadef-namespace-show-response.json} | 0 ...ema-metadef-namespaces-list-response.json} | 0 ... schema-metadef-object-show-response.json} | 0 ...schema-metadef-objects-list-response.json} | 0 ...ema-metadef-properties-list-response.json} | 0 ...chema-metadef-property-show-response.json} | 0 ...ource-type-association-show-response.json} | 0 ...urce-type-associations-list-response.json} | 0 ... => schema-metadef-tag-show-response.json} | 0 ...=> schema-metadef-tags-list-response.json} | 0 ... schemas-image-members-list-response.json} | 0 ...json => schemas-images-list-response.json} | 0 ...-request.json => task-create-request.json} | 0 ...-response.json => task-show-response.json} | 0 .../{os-image-v2.wadl => wadl/images-v2.wadl} | 250 ++++++++---------- .../metadefs-namespaces-objects-v2.wadl} | 93 +++---- .../metadefs-namespaces-properties-v2.wadl} | 79 +++--- .../metadefs-namespaces-tags-v2.wadl} | 38 +-- .../metadefs-namespaces-v2.wadl} | 38 +-- .../metadefs-resource_types-v2.wadl} | 31 ++- .../schemas-metadefs-v2.wadl} | 112 ++++---- .../schemas-v2.wadl} | 54 ++-- 55 files changed, 518 insertions(+), 648 deletions(-) rename api-ref/src/wadls/image-api/src/samples/{extensions.json => extensions-list-response.json} (91%) rename api-ref/src/wadls/image-api/src/v1/samples/{imagememberships.json => image-members-add-request.json} (100%) rename api-ref/src/wadls/image-api/src/v1/samples/{imagemembershiplist.json => image-memberships-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v1/samples/{imagedetails.json => images-list-details-response.json} (100%) rename api-ref/src/wadls/image-api/src/v1/samples/{imagelist.json => images-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v1/samples/{shared-images.json => shared-images-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v1/{os-image-1.0.wadl => wadl/images-v1.wadl} (82%) rename api-ref/src/wadls/image-api/src/v2/samples/{image-create-req.json => image-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{image-details-response.json => image-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{image-update-req.json => image-update-request.json} (99%) rename api-ref/src/wadls/image-api/src/v2/samples/{image-list-response.json => images-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-namespace-create-req.json => metadef-namespace-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-namespace-update-req.json => metadef-namespace-update-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-namespace-list-response.json => metadef-namespaces-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-object-create-req.json => metadef-object-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-object-update-req.json => metadef-object-update-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-object-list-response.json => metadef-objects-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-property-list-response.json => metadef-properties-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-property-create-req.json => metadef-property-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-property-update-req.json => metadef-property-update-request.json} (100%) delete mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-resource-type-assoc-create-req.json => metadef-resource-type-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-resource-type-list-response.json => metadef-resource-types-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-tag-create-req.json => metadef-tag-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-tag-update-req.json => metadef-tag-update-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{metadef-tag-list-response.json => metadef-tags-list-response.json} (100%) delete mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-image-get-response.json rename api-ref/src/wadls/image-api/src/v2/samples/{schemas-image-member-get-response.json => schema-image-member-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schemas-image-get-response.json => schema-image-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-namespace-get-response.json => schema-metadef-namespace-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-namespaces-get-response.json => schema-metadef-namespaces-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-object-get-response.json => schema-metadef-object-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-objects-get-response.json => schema-metadef-objects-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-properties-get-response.json => schema-metadef-properties-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-property-get-response.json => schema-metadef-property-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-resource-type-association-get-response.json => schema-metadef-resource-type-association-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-resource-type-associations-get-response.json => schema-metadef-resource-type-associations-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-tag-get-response.json => schema-metadef-tag-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schema-metadef-tags-get-response.json => schema-metadef-tags-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schemas-image-members-get-response.json => schemas-image-members-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{schemas-images-get-response.json => schemas-images-list-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{tasks-create-request.json => task-create-request.json} (100%) rename api-ref/src/wadls/image-api/src/v2/samples/{tasks-show-response.json => task-show-response.json} (100%) rename api-ref/src/wadls/image-api/src/v2/{os-image-v2.wadl => wadl/images-v2.wadl} (83%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-object-v2.wadl => wadl/metadefs-namespaces-objects-v2.wadl} (80%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-property-v2.wadl => wadl/metadefs-namespaces-properties-v2.wadl} (89%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-tag-v2.wadl => wadl/metadefs-namespaces-tags-v2.wadl} (88%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-namespace-v2.wadl => wadl/metadefs-namespaces-v2.wadl} (93%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-resourcetype-v2.wadl => wadl/metadefs-resource_types-v2.wadl} (89%) rename api-ref/src/wadls/image-api/src/v2/{os-metadef-schemas-v2.wadl => wadl/schemas-metadefs-v2.wadl} (74%) rename api-ref/src/wadls/image-api/src/v2/{os-image-schemas-v2.wadl => wadl/schemas-v2.wadl} (75%) diff --git a/api-ref/src/docbkx/ch_images-v1.xml b/api-ref/src/docbkx/ch_images-v1.xml index d22478e65..cf7b6c36b 100644 --- a/api-ref/src/docbkx/ch_images-v1.xml +++ b/api-ref/src/docbkx/ch_images-v1.xml @@ -12,27 +12,26 @@ assigns metadata to images. Some cloud implementations do not expose this API and offer pretested images only. - Cloud providers can configure property protections that - prevent non-administrative users from updating and deleting - protected properties. For more information, see Image property protection in the - OpenStack Cloud Administrator - Guide. + + Cloud providers can configure property protections that prevent non-administrative users + from updating and deleting protected properties. For more information, see Image property protection in the + OpenStack Cloud Administrator Guide. +
API versions + href="../wadls/image-api/src/v1/wadl/images-v1.wadl#versions"> + href="../wadls/image-api/src/v1/wadl/images-v1.wadl#versionspath"> @@ -40,19 +39,14 @@
Images - - + + - - - - - - + + + + @@ -61,12 +55,10 @@
Members - + - + @@ -75,9 +67,8 @@
Shared images - - + +
diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 36124a639..a9ce4ac3a 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -10,22 +10,16 @@ Image service API v2 (CURRENT) Image service API v2.0, API v2.1, API v2.2, and API v2.3. - Cloud providers can configure property protections that prevent - non-administrative users from updating and deleting protected properties. - For more information, see Image property - protection in the OpenStack Cloud Administrator + Cloud providers can configure property protections that prevent non-administrative users + from updating and deleting protected properties. For more information, see Image + property protection in the OpenStack Cloud Administrator Guide.
API versions - - - - + @@ -57,7 +51,7 @@ The Image service reserved an image ID for the - image in the registry but has not uploaded any + image in the registry but did not yet upload any image data. @@ -84,7 +78,7 @@ killed - An error occurred during the upload of image data. + An image data upload error occurred. @@ -111,23 +105,18 @@ - + - - - - - + + + + - + - + @@ -136,10 +125,9 @@ Image data Uploads and downloads raw image data. - + - +
@@ -147,8 +135,7 @@ Image tags Adds and deletes image tags. - + @@ -157,14 +144,11 @@
Members - + - - - + + @@ -175,25 +159,21 @@ Gets a JSON-schema document that represents an images or image entity. - - + + - - + + - - + + - - + +
-
+
Metadata definition resource types (since API v2.0) Lists resource types. Also, creates, lists, and @@ -201,161 +181,151 @@ + href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types"> + href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types_assoc"> + href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#name">
-
+
Metadata definition namespaces (since API v2.0) - Creates, lists, gets details for, updates, and - deletes metadata definition namespaces. Defines namespaces that can contain - property definitions, object definitions, and resource type associations. + Creates, lists, shows details for, updates, and deletes metadata + definition namespaces. Defines namespaces that can contain + property definitions, object definitions, and resource type + associations. + href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl#namespaces"> - + href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl#namespace"> +
-
+
Metadata definition properties (since API v2.0) - Creates, lists, gets details for, updates, and - deletes metadata definition properties. + Creates, lists, shows details for, updates, and deletes metadata + definition properties. + href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl#properties"> - - + +
-
+
Metadata definition objects (since API v2.0) - Creates, lists, gets details for, updates, and deletes metadata + Creates, lists, shows details for, updates, and deletes metadata definition objects. - + - - + +
-
+
Metadata definition tags (since API v2.0) - Creates, lists, gets details for, updates, and deletes metadata + Creates, lists, shows details for, updates, and deletes metadata definition tags. - + - + - +
-
+
Metadata definition schemas Gets a JSON-schema document that represents a metadata definition entity. - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
Tasks (since API v2.2) - Creates, lists, and gets details for tasks. + Creates, lists, and shows details for tasks. - + href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Tasks"> + - - + +
diff --git a/api-ref/src/wadls/image-api/src/samples/extensions.json b/api-ref/src/wadls/image-api/src/samples/extensions-list-response.json similarity index 91% rename from api-ref/src/wadls/image-api/src/samples/extensions.json rename to api-ref/src/wadls/image-api/src/samples/extensions-list-response.json index a977d991b..21da3b262 100644 --- a/api-ref/src/wadls/image-api/src/samples/extensions.json +++ b/api-ref/src/wadls/image-api/src/samples/extensions-list-response.json @@ -1,3 +1,3 @@ { "key": "value" -} \ No newline at end of file +} diff --git a/api-ref/src/wadls/image-api/src/v1/common.ent b/api-ref/src/wadls/image-api/src/v1/common.ent index d9e5d5bf3..7b25860d6 100644 --- a/api-ref/src/wadls/image-api/src/v1/common.ent +++ b/api-ref/src/wadls/image-api/src/v1/common.ent @@ -316,8 +316,8 @@ false. - The owner ID, which is the tenant ID, is - specified in the request URI. + Specify the owner ID, which is the tenant ID, is + in the request URI. '> diff --git a/api-ref/src/wadls/image-api/src/v1/samples/imagememberships.json b/api-ref/src/wadls/image-api/src/v1/samples/image-members-add-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v1/samples/imagememberships.json rename to api-ref/src/wadls/image-api/src/v1/samples/image-members-add-request.json diff --git a/api-ref/src/wadls/image-api/src/v1/samples/imagemembershiplist.json b/api-ref/src/wadls/image-api/src/v1/samples/image-memberships-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v1/samples/imagemembershiplist.json rename to api-ref/src/wadls/image-api/src/v1/samples/image-memberships-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v1/samples/imagedetails.json b/api-ref/src/wadls/image-api/src/v1/samples/images-list-details-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v1/samples/imagedetails.json rename to api-ref/src/wadls/image-api/src/v1/samples/images-list-details-response.json diff --git a/api-ref/src/wadls/image-api/src/v1/samples/imagelist.json b/api-ref/src/wadls/image-api/src/v1/samples/images-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v1/samples/imagelist.json rename to api-ref/src/wadls/image-api/src/v1/samples/images-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v1/samples/shared-images.json b/api-ref/src/wadls/image-api/src/v1/samples/shared-images-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v1/samples/shared-images.json rename to api-ref/src/wadls/image-api/src/v1/samples/shared-images-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl b/api-ref/src/wadls/image-api/src/v1/wadl/images-v1.wadl similarity index 82% rename from api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl rename to api-ref/src/wadls/image-api/src/v1/wadl/images-v1.wadl index fa2d4fcf7..9e237ab1f 100644 --- a/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl +++ b/api-ref/src/wadls/image-api/src/v1/wadl/images-v1.wadl @@ -3,14 +3,14 @@ - + - + + %common; - + %common_project; ]> - - + + @@ -44,8 +44,8 @@ id="detail"/> &image_idRequestParameter; - - + + @@ -61,7 +61,7 @@ &owner_idRequestParameter; - + @@ -70,16 +70,18 @@ - + - + - Details for a version. + + Details for a version. + @@ -89,9 +91,10 @@ Lists information about available Image - service API versions. + xml:lang="EN" title="List API versions"> + + Lists information about all Image service API versions. + @@ -99,7 +102,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> + href="../samples/image-versions-response.json"/> @@ -107,9 +110,10 @@ Lists information about available Image - service API versions. + xml:lang="EN" title="List API versions"> + + Shows details for the Image service API v1. + @@ -117,7 +121,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> + href="../samples/image-versions-response.json"/> @@ -126,8 +130,9 @@ - Registers a virtual machine (VM) - image. + + Registers a virtual machine (VM) image. + - Name for the image. Note that the name - of an image is not unique to a Glance - node. The API cannot expect users to know - the names of images owned by - others. + + Name for the image. Note that the name of an image + is not unique to an Image service node. The API + cannot expect users to know the names of images + that other users own. + &disk_formatRequestParameter; @@ -162,8 +168,7 @@ - A location for the image identified by a - URI. + A URI location for the image. @@ -191,7 +196,7 @@ - + @@ -206,7 +211,7 @@ - + @@ -220,13 +225,13 @@ - + - Lists the VM images that are shared with an owner. - The owner ID is the tenant ID. + Lists the VM images that an owner shares. The owner ID is the + tenant ID. @@ -240,16 +245,16 @@ - + - + - Lists public VM images. + Lists all public VM images. @@ -263,17 +268,17 @@ - + - + - Lists details for available - images. + xml:lang="EN" title="List images with details"> + Lists all available + images with details. @@ -311,7 +316,7 @@ - + @@ -319,8 +324,10 @@ - Adds a member to an image. + xml:lang="EN" title="Add members to image"> + + Adds one or more members to an image. + If you omit the request body, this call adds the membership to the image, leaves the existing memberships unmodified, and @@ -334,7 +341,7 @@ - + &can_shareRequestParameter; @@ -345,8 +352,9 @@ - Replaces a membership list for an - image. + + Replaces a membership list for an image. + &can_shareRequestParameter; - + @@ -371,12 +379,14 @@ element="image"> + type="csapi:UUID"> - ID of member with which an image is - shared. + + The UUID of the member with which an image is + shared. + 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 588bca8b5..2efb13b99 100644 --- a/api-ref/src/wadls/image-api/src/v2/common.ent +++ b/api-ref/src/wadls/image-api/src/v2/common.ent @@ -105,12 +105,10 @@ - Filter parameter. + Filters the response by a tenant ID. - Shows only images that are shared with this owner. - - A valid value is a tenant ID. + Shows only images that are shared with this tenant owner. @@ -292,15 +290,15 @@ '> + style="plain" required="true" type="csapi:UUID"> - The unique ID for the image. + The UUID of the image. '> + style="plain" required="true" type="csapi:UUID"> The minimum amount of RAM in MB that is required to boot the image. @@ -373,12 +371,12 @@ '> + style="template" type="csapi:UUID" required="true"> + title="Image UUID"> - Image ID stored through the image API. Typically a UUID. + The UUID of the image. '> @@ -745,7 +743,7 @@ '> + style="template" type="csapi:UUID" required="true"> @@ -1257,10 +1255,10 @@ '> + style="plain" required="true" type="csapi:UUID" default="ALL"> - The task ID. + The UUID of the task. '> diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/image-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/image-create-request.json 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-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/image-details-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/image-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-update-req.json b/api-ref/src/wadls/image-api/src/v2/samples/image-update-request.json similarity index 99% rename from api-ref/src/wadls/image-api/src/v2/samples/image-update-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/image-update-request.json index e0542750a..9bbc50b20 100644 --- a/api-ref/src/wadls/image-api/src/v2/samples/image-update-req.json +++ b/api-ref/src/wadls/image-api/src/v2/samples/image-update-request.json @@ -12,4 +12,4 @@ "beefy" ] } -] \ No newline at end of file +] 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/images-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/image-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/images-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespaces-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-namespaces-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-objects-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-object-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-objects-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-properties-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-property-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-properties-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json deleted file mode 100644 index 672fe4651..000000000 --- a/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "resource_type_associations": [ - { - "created_at": "2014-09-19T16:13:33Z", - "name": "OS::Glance::Image", - "prefix": "hw_", - "updated_at": "2014-09-19T16:13:33Z" - }, - { - "created_at": "2014-09-19T16:09:13Z", - "name": "OS::Cinder::Volume", - "prefix": "hw_", - "properties_target": "image", - "updated_at": "2014-09-19T16:09:13Z" - } - ] -} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-types-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-types-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-req.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-req.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tags-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-list-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/metadef-tags-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-image-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-image-get-response.json deleted file mode 100644 index 02beb7e80..000000000 --- a/api-ref/src/wadls/image-api/src/v2/samples/schema-image-get-response.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "additionalProperties": { - "type": "string" - }, - "links": [ - { - "href": "{self}", - "rel": "self" - }, - { - "href": "{file}", - "rel": "enclosure" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ], - "name": "image", - "properties": { - "checksum": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "file": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "protected": { - "type": "boolean" - }, - "schema": { - "type": "string" - }, - "self": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "status": { - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "updated_at": { - "type": "string" - }, - "visibility": { - "enum": [ - "public", - "private" - ] - } - } -} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schemas-image-member-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-image-member-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schemas-image-member-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-image-member-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schemas-image-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-image-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schemas-image-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-image-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tag-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tag-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tag-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tag-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tags-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tags-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tags-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tags-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schemas-image-members-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schemas-image-members-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schemas-image-members-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schemas-image-members-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/schemas-images-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schemas-images-list-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/schemas-images-get-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/schemas-images-list-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/tasks-create-request.json b/api-ref/src/wadls/image-api/src/v2/samples/task-create-request.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/tasks-create-request.json rename to api-ref/src/wadls/image-api/src/v2/samples/task-create-request.json diff --git a/api-ref/src/wadls/image-api/src/v2/samples/tasks-show-response.json b/api-ref/src/wadls/image-api/src/v2/samples/task-show-response.json similarity index 100% rename from api-ref/src/wadls/image-api/src/v2/samples/tasks-show-response.json rename to api-ref/src/wadls/image-api/src/v2/samples/task-show-response.json diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl similarity index 83% rename from api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl index ec30b379b..7cd0f2bca 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl @@ -5,12 +5,12 @@ - + + %common; - + %common_project; ]> - - + + - - - - - + + - + &image_idParameter; - + @@ -55,7 +52,7 @@ - + @@ -69,7 +66,7 @@ &member_idParameter; - + @@ -77,10 +74,10 @@ - + - + @@ -97,36 +94,19 @@ - + - Lists information about available Image + + Lists information about available Image service API versions. - + - - - - - - - Lists information about available Image - service API versions. - - - - - - + href="../samples/image-versions-response.json"/> @@ -151,27 +131,27 @@ marker parameters. - The list operation accepts several types of query parameters that - let you filter the results of the returned collection. + The list operation accepts several query parameters. Use these + parameters to filter the response. - A client can provide direct comparison filters using most image + A client can provide direct comparison filters by using most image attributes, such as name=Ubuntu, - visibility=public, and so on. A client cannot filter - on tags or anything defined as a link in the json- - schema, such as self, file, or schema. + visibility=public, and so on. A client cannot use + tags or any link in the json-schema, such as self, file, + or schema, to filter the response. You can use the size_min and size_max - query parameters to perform greater-than and less-than filtering - of images based on their size attribute. The size is - measured in bytes and refers to the size of an image when it is - stored on disk. + query parameters to filter images that are greater than or less + than the image size. The size, in bytes, is the size of an image + on disk. - For example, sending a size_min filter of 1048576 and - size_max of 4194304 filters the container to include - only images that are between 1 and 4 MB. + For example, to filter the container to include only images that + are from 1 to 4 MB, set the size_min query + parameter to 1048576 and the size_max + query parameter to 4194304. You can list VM images that have a status of active, @@ -183,9 +163,8 @@ - sort_key. Sorts by the requested image - attribute. Sorts in the natural sorting direction of the image attribute that - is provided as the sort_key. + sort_key. Sorts by an image + attribute. Sorts in the natural sorting direction of the image attribute. @@ -204,10 +183,10 @@ To specify the sort_key and sort_dir query parameters to sort the results: - GET /v2/images?sort_key=name&sort_dir=asc&sort_key=status&sort_dir=desc +GET /v2/images?sort_key=name&sort_dir=asc&sort_key=status&sort_dir=desc To specify the sort query parameter to sort the results: - GET /v2/images?sort=name:asc,status:desc +GET /v2/images?sort=name:asc,status:desc @@ -220,7 +199,7 @@ + href="../samples/images-list-response.json"/> &imagesParameter; &statusParameter; &nameParameter; &tagsParameter; &container_formatParameter; @@ -244,9 +223,10 @@ (Since Image API v2.0) Creates a virtual machine (VM) image. - Created with a Location header that - contains the newly-created URI for the image. Response - body represents the created image entity. + + The response includes a Location response header that + contains the URI for the image. The response body contains the new + image entity. Synchronous Postconditions @@ -257,10 +237,10 @@ - With correct permissions, you can see - the image status as active through API - calls if you created the image with - Location header. + + If you create the image with the Location + header and you have correct permissions, you can use API + calls to see the image status as active. @@ -270,7 +250,7 @@ element="image"> - + - Name for the image. The name of an image is not unique to an - Image service node. The API cannot expect users to know the - names of images owned by others. + Name for the image. Note that the name of an image + is not unique to an Image service node. The API + cannot expect users to know the names of images + that other users own. + href="../samples/image-create-response.json"/> &statusParameter; &container_formatParameter; &min_ramParameter; &updated_at-ResponseParameter; @@ -384,7 +365,7 @@ - A new value is inserted into the array at the index. + The API inserts a new value into the array at the index. @@ -396,7 +377,7 @@ - A new member is added to the object. + The API adds a member to the object. @@ -438,19 +419,20 @@ - A member to add to an object. The value is added to that - object at that location. If the member already exists, it is - replaced by the value. + A member value to add to an object. The API adds the value + to the object at the location. If the member already exists, + the API replaces it with the value. - An element to add to the array. The value is added to the - array at the location. Any element that is at or above the - index is shifted one position to the right. The index must - not be greater than the number of elements in the array. If - you use the hyphen (-) character to index the end of the - array, the value is appended to the array. See JavaScript Object Notation (JSON) Pointer. @@ -538,7 +520,7 @@ - + &pathParameter; &valueParameter; &opParameter; &urlParameter; &metadataParameter; @@ -549,7 +531,7 @@ + href="../samples/image-update-response.json"/> &statusParameter; &nameParameter; &tagsParameter; &container_formatParameter; @@ -564,7 +546,7 @@ - + (Since Image API v2.0) Shows details for an image. @@ -582,7 +564,7 @@ + href="../samples/image-show-response.json"/> &statusParameter; &nameParameter; &tagsParameter; &container_formatParameter; @@ -619,7 +601,7 @@ + href="../samples/image-show-response.json"/> @@ -630,9 +612,10 @@ (Since Image API v2.0) Deactivates an image. - If you try to download a deactivated image, the 403 Forbidden - error is returned. Also, image locations are not visible for - deactivated images unless the user is an administrative user. + If you try to download a deactivated image, the call returns the + Forbidden (403) response code. Also, only + administrative users can view image locations for deactivated + images. The deactivate operation returns an error if the image status is @@ -650,7 +633,7 @@ + href="../samples/image-details-deactivate-response.json"/> @@ -686,13 +669,13 @@ - The image is deleted in images index. + The API deletes the image from the images index. - The binary image data managed by OpenStack - Image service is deleted from the storage node if the - deleted image stores image data in the node. + + If the image stores binary image data in the storage node, + the OpenStack Image service deletes the data from the node. @@ -775,10 +758,10 @@ - If you cannot store the data, your request might lack - information or you exceeded your allotted quota. Ensure that - you meet the preconditions and run the request again. If the - request fails again, review your API request. + If you cannot store the data, either your request lacks + required information or you exceeded your allotted quota. + Ensure that you meet the preconditions and run the request + again. If the request fails again, review your API request. @@ -791,7 +774,7 @@ - + (Since @@ -802,12 +785,10 @@ $image_url/v2/images/{image_id}/file - The response body contains the raw binary data that represents the - actual virtual disk. The Content-Type header contains - the application/octet-stream value. The Content-MD5 header contains an MD5 checksum of the image - data. Clients are encouraged to use this checksum to verify the - integrity of the image data that they receive. + The response body contains the raw binary data that represents the actual virtual disk. + The Content-Type header contains the application/octet-stream + value. The Content-MD5 header contains an MD5 checksum of the image data. + Use this checksum to verify the integrity of the image data. Preconditions @@ -865,7 +846,7 @@ - + (Since Image API v2.2) Shows image member details. @@ -889,7 +870,7 @@ @@ -899,16 +880,16 @@ - (Since Image API v2.1) Lists the tenants with whom this - image has been shared. + + (Since Image API v2.1) Lists the tenants that share this image. - If a user with whom this image is shared makes this - call, the member list contains only information for - that user. + + If a user who shares this image makes this call, the + member list contains only information for that user. - If a user with whom this image has not been shared - makes this call, the call returns the HTTP 404 status - code. + + If a user who does not share this image makes this call, the call + returns the HTTP 404 response code. Preconditions @@ -928,7 +909,7 @@ @@ -999,7 +980,7 @@ @@ -1009,7 +990,7 @@ @@ -1047,15 +1028,16 @@ Synchronous Postconditions - If you update the member status to - accepted and have the correct permissions, - you see the image in list images responses. + + If you update the member status to accepted and + have the correct permissions, you see the image in list + images responses. - With correct permissions, you can see - the updated member status of the image through API - calls. + + With correct permissions, you can make API calls to see the + updated member status of the image. @@ -1065,7 +1047,7 @@ @@ -1115,7 +1097,7 @@ Synchronous Postconditions - The member is removed from + The API removes the member from the image members. @@ -1155,14 +1137,14 @@ + href="../samples/tasks-list-response.json"/> - + + title="Create task"> Creates a task. @@ -1170,16 +1152,16 @@ + href="../samples/task-create-request.json"/> - + + title="Show task details"> Shows details for a task. @@ -1193,7 +1175,7 @@ + href="../samples/task-show-response.json"/> diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl similarity index 80% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl index 2c9d5d6b9..c68b7880e 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl @@ -1,16 +1,16 @@ - - - - - - - + + + + + + + + %common; - + %common_project; ]> - - + + @@ -48,7 +48,7 @@ The name of the object. - + @@ -74,7 +74,7 @@ element="image"> - + + href="../samples/metadef-object-create-response.json"/> &metadefNamespaceParameter; &metadefNSDisplayNameParameter; &metadefNSDescParameter; &metadefNSVisibilityParameter; &metadefNSProtectedParameter; &metadefPropertiesParameter; @@ -167,9 +167,10 @@ - Lists object definitions within - a namespace. + title="List object definitions"> + + Lists object definitions in a namespace. + Returns a subset of the larger collection of namespaces and a link that you can use to get the next set of namespaces. You @@ -184,15 +185,15 @@ parameters. - The list operation accepts resource_types and - visibility as query parameters that let you - filter the results of the returned collection. + Use the resource_types and + visibility query parameters to filter the + response. - For example, sending a resource_types filter of - OS::Glance::Image,OS::Nova::Flavor filters the - namespaces to include only namespaces that are associated to - the given resource types. + For example, set the resource_types query + parameter to OS::Glance::Image,OS::Nova::Flavor + to filter the response to include only namespaces that are + associated with the given resource types. You can sort the results of this operation by using the @@ -210,26 +211,29 @@ + href="../samples/metadef-objects-list-response.json"/> &namespacesParameter; &metadefNamespaceParameter; &metadefNSDisplayNameParameter; &metadefNSDescParameter; &metadefNSVisibilityParameter; &metadefNSProtectedParameter; &metadefResTypeAssocsParameter; - + - Gets the definition for an object. - - Response body is a single object entity. + title="Show object definition"> + + Shows the definition for an object. + + + The response body shows a single object entity. + + href="../samples/metadef-object-details-response.json"/> @@ -238,8 +242,7 @@ - Updates an object definition in a - namespace. + Updates an object definition in a namespace. @@ -247,7 +250,7 @@ element="image"> - + @@ -256,7 +259,7 @@ + href="../samples/metadef-object-update-response.json"/> @@ -265,23 +268,21 @@ - Deletes an object definition within a namespace. + Deletes an object definition from a namespace. - You cannot delete objects in a namespace with the 'protected' - attribute set to true (boolean); the response returns - the HTTP 403 status code. + To delete a protected object from a namespace, you must + first set the protected attribute to false + (boolean) on the namespace and then perform the delete. If you + try to delete a protected object, the call returns the + 403 response code. - You must first set the protected attribute to - false (boolean) on the namespace and then perform the delete. - The response is empty and returns the HTTP 204 status code. + When you successfully delete an object from a namespace, the + response is empty and and the response code is + 204. - - - - diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl similarity index 89% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl index abeccfe45..e86a6849c 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl @@ -1,16 +1,16 @@ - - - - - - - + + + + + + + + %common; - + %common_project; ]> - - + + @@ -41,7 +41,7 @@ - + @@ -59,10 +59,10 @@ - Creates a property definition within a namespace. + Creates a property definition in a namespace. - The schema is a subset of JSON property definition schema. + The schema is a subset of the JSON property definition schema. @@ -70,7 +70,7 @@ element="image"> - + &metadefPropertyNameParameter; &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; @@ -90,7 +90,7 @@ + href="../samples/metadef-property-create-response.json"/> &metadefPropertyNameParameter; &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; @@ -107,11 +107,10 @@ - Lists property definitions within - a namespace. - Returns a list of property definitions in a - namespace. + title="List property definitions"> + + Lists property definitions in a namespace. + @@ -122,7 +121,7 @@ + href="../samples/metadef-properties-list-response.json"/> &metadefPropertyListParameter; &metadefPropertyNameParameter; &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; @@ -138,19 +137,22 @@ - + - Gets the definition for a property. + title="Show property definition"> + + Shows the definition for a property. - If you include the resource_type query - parameter, the prefix of the included resource type is removed - from the property name before the query is submitted. This - enables you to look for a property name that starts with a - prefix from an associated resource type. + If you use the resource_type query parameter, the + API removes the prefix of the resource type from the property + name before it submits the query. This enables you to look for + a property name that starts with a prefix from an associated + resource type. + + + The response body shows a single property entity. - Response body shows a single property entity. @@ -168,7 +170,7 @@ from an associated resource type. - The prefix of the included resource type is removed + The API removes the prefix of the resource type from the property name in the response. @@ -180,7 +182,7 @@ + href="../samples/metadef-property-details-response.json"/> &metadefPropertyNameParameter; &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; @@ -199,15 +201,16 @@ - Updates a property definition. - + + Updates a property definition. + - + + href="../samples/metadef-property-update-response.json"/> - &metadefPropertyNameParameter; + &metadefPropertyNameParameter; &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; &metadefPropertyDescParameter; &metadefPropertyOperParameter; diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-tag-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl similarity index 88% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-tag-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl index c137f65f7..be62bdf77 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-tag-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl @@ -1,16 +1,16 @@ - - - + + + - - - + + + + %common; - + %common_project; ]> - - + + @@ -42,7 +42,7 @@ - + @@ -68,7 +68,7 @@ + href="../samples/metadef-tag-create-request.json"/> &metadefNamespaceParameter; &metadefTagsParameter; @@ -80,7 +80,7 @@ + href="../samples/metadef-tag-create-response.json"/> &metadefTagsParameter; &metadefTagNameParameter; @@ -111,7 +111,7 @@ + href="../samples/metadef-tags-list-response.json"/> &metadefTagsParameter; &metadefTagNameParameter; @@ -161,12 +161,12 @@ + href="../samples/metadef-tag-add-response.json"/> &metadefTagNameParameter; - + @@ -185,7 +185,7 @@ + href="../samples/metadef-tag-details-response.json"/> &metadefTagNameParameter; @@ -201,7 +201,7 @@ - + &metadefNamespaceParameter; &metadefTagNameParameter; @@ -212,7 +212,7 @@ + href="../samples/metadef-tag-update-response.json"/> &metadefTagNameParameter; diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl similarity index 93% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl index c2a96ee38..e21f85280 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl @@ -3,14 +3,14 @@ - + - + + %common; - + %common_project; ]> - - + + @@ -48,7 +48,7 @@ - + @@ -67,8 +67,8 @@ Creates a namespace. - The namespace is created with a Location header - that contains the newly-created URI for the namespace. + The Location response header + contains the newly-created URI for the namespace. @@ -76,7 +76,7 @@ element="image"> - + - User-friendly name that can be used in UI to + User-friendly name that you can use in the UI to display the namespace name. @@ -177,7 +177,7 @@ + href="../samples/metadef-namespace-create-response.json"/> &metadefNamespaceParameter; &metadefNSDisplayNameParameter; &metadefNSDescParameter; &metadefNSVisibilityParameter; @@ -205,8 +205,8 @@ The list operation accepts the resource_types and - visibility query parameters, which let you filter - the results in the returned collection. + visibility query parameters, which you can use to filter + the response. To sort the results of this operation, use the @@ -267,7 +267,7 @@ + href="../samples/metadef-namespaces-list-response.json"/> &namespacesParameter; &metadefNamespaceParameter; &metadefNSDisplayNameParameter; &metadefNSDescParameter; @@ -276,7 +276,7 @@ - + @@ -292,7 +292,7 @@ + href="../samples/metadef-namespace-details-response.json"/> @@ -306,7 +306,7 @@ - + &metadefNamespace_idParameter; @@ -316,7 +316,7 @@ + href="../samples/metadef-namespace-update-response.json"/> diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl similarity index 89% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl index 6a982839a..67f4e1fdb 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl @@ -3,14 +3,14 @@ - + - + + %common; - + %common_project; ]> - - + + @@ -86,7 +86,7 @@ + href="../samples/metadef-resource-type-create-request.json"/> - Prefix for the resource type. If you specify a - prefix, you must use this value followed by a - prefix separator, such as the colon - (:) character, to prefix any - properties in the namespace that you want to apply - to the resource type. + Prefix for any properties in the namespace that + you want to apply to the resource type. If you + specify a prefix, you must append a prefix + separator, such as the colon (:) + character. @@ -136,7 +135,7 @@ + href="../samples/metadef-resource-type-assoc-create-response.json"/> @@ -156,7 +155,7 @@ + href="../samples/metadef-resource-types-list-response.json"/> @@ -176,7 +175,7 @@ + href="../samples/metadef-resource-types-list-response.json"/> diff --git a/api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl similarity index 74% rename from api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl index 05b2b449e..778d5ad3d 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl @@ -4,15 +4,15 @@ - + - + + %common; - + %common_project; ]> - - + + @@ -41,43 +41,43 @@ - + - + - + - + - + - + - + - + - + - + @@ -88,11 +88,11 @@ - + + title="Show metadata definition namespace schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition namespace entity. (Since API v2.1.) @@ -105,17 +105,17 @@ - + + title="Show metadata definition namespaces schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition namespaces entity. (Since API v2.1.) @@ -131,17 +131,17 @@ - + + title="Show metadata definition object schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition object entity. (Since API v2.1.) @@ -154,17 +154,17 @@ - + + title="Show metadata definition objects schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition objects entity. (Since API v2.1.) @@ -180,17 +180,17 @@ - + + title="Show metadata definition property schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition property entity. (Since API v2.1.) @@ -203,17 +203,17 @@ - + + title="Show metadata definition properties schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition properties entity. (Since API v2.1.) @@ -229,17 +229,17 @@ - + + title="Show metadata definition tag schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition tag entity. (Since API v2.1.) @@ -252,17 +252,17 @@ - + + title="Show metadata definition tags schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition tags entity. (Since API v2.1.) @@ -278,17 +278,17 @@ - + + title="Show metadata definition namespace resource type association schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition namespace resource type association entity. (Since API v2.1.) @@ -302,17 +302,17 @@ - + + title="Show metadata definition namespace resource type associations schema"> - Gets a JSON schema document that represents a metadata + Shows a JSON schema document that represents a metadata definition namespace resource type associations entity. (Since API v2.1.) @@ -330,7 +330,7 @@ diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl similarity index 75% rename from api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl rename to api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl index 64d5ed9c1..dbcb2aa29 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl @@ -1,18 +1,18 @@ - + - + - + + %common; - + %common_project; ]> - - + + @@ -38,19 +38,19 @@ - + - + - + - + @@ -60,10 +60,10 @@ - + - Gets a json-schema document that + title="Show images schema"> + Shows a JSON schema document that represents an images entity. (Since Images v2.0.) An images entity is a container of image @@ -77,16 +77,16 @@ - + - Gets a json-schema document that + title="Show image schema"> + Shows a JSON schema document that represents an image entity. (Since Images v2.0.) The following schema is solely an example. Consider @@ -98,16 +98,16 @@ - + - Gets a json-schema document that + title="Show image members schema"> + Shows a JSON schema document that represents an image members entity. (Since Images v2.1.) An image members entity is a container of image @@ -121,16 +121,16 @@ - + - Gets a json-schema document that + title="Show image member schema"> + Shows a JSON schema document that represents an image member entity. (Since Images v2.1.) The following schema is solely an example. Consider @@ -142,7 +142,7 @@