diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 913d3f131..7530795ba 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -10,11 +10,12 @@ 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 - Guide. + property protection in the OpenStack Cloud + Administrator Guide.
API versions @@ -25,7 +26,7 @@
- Images + Images (images) Creates, lists, updates, and deletes images. Image operations show all fields in the response body. Any field @@ -123,8 +124,10 @@
- Image data - Uploads and downloads raw image data. + Image data (images, file) + + Uploads and downloads raw image data. + @@ -133,8 +136,10 @@
- Image tags - Adds and deletes image tags. + Image tags (images, tags) + + Adds and deletes image tags. + @@ -143,7 +148,10 @@
- Members + Members (images, members) + + Creates, lists, updates, and deletes image members. + @@ -151,172 +159,78 @@ - +
- Image schemas - Gets a JSON-schema document that represents an images or - image entity. - - - - - - - - - - - - - - + Image schemas (schemas, image, images, member, members) + + Gets a JSON-schema document that represents an images or image + entity. + +
- Metadata definition resource types (since API v2.0) + Metadata definition resource types (since API v2.0) (metadefs, namespaces, resource_types) - Lists resource types. Also, creates, lists, and - removes resource type associations in a namespace. + Lists resource types. Also, creates, lists, and removes resource + type associations in a namespace. - - - - - - - - - - - - +
-
- Metadata definition namespaces (since API v2.0) +
+ Metadata definition namespaces (since API v2.0) (metadefs, namespaces) Creates, lists, shows details for, updates, and deletes metadata definition namespaces. Defines namespaces that can contain property definitions, object definitions, and resource type associations. - - - - - - - - - - - +
-
- Metadata definition properties (since API v2.0) +
+ Metadata definition properties (since API v2.0) (metadefs, namespaces, properties) Creates, lists, shows details for, updates, and deletes metadata definition properties. - - - - - - - - - - - +
-
- Metadata definition objects (since API v2.0) +
+ Metadata definition objects (since API v2.0) (metadefs, namespaces, objects) Creates, lists, shows details for, updates, and deletes metadata definition objects. - - - - - - - - - - - +
- Metadata definition tags (since API v2.0) + Metadata definition tags (since API v2.0) (metadefs, namespaces, tags) Creates, lists, shows details for, updates, and deletes metadata definition tags. - - - - - - - - - - - - - +
- Metadata definition schemas + Metadata definition schemas (schemas, metadefs, namespace, namespaces, object, objects, property, properties, tag, tags, resource_type, resource_types) Gets a JSON-schema document that represents a metadata definition entity. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
- Tasks (since API v2.2) + Tasks (since API v2.2) (tasks) Creates, lists, and shows details for tasks. diff --git a/api-ref/src/wadls/common_project.ent b/api-ref/src/wadls/common_project.ent index d765e9e35..0dfdafddc 100644 --- a/api-ref/src/wadls/common_project.ent +++ b/api-ref/src/wadls/common_project.ent @@ -56,7 +56,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The date and time before which to list usage audits. + Filters the response by the date and time before which to list usage audits. The date and time stamp format is - The date and time when the image or server last changed status. + Filters the response by the date and time when the image or server last changed status. Use this query parameter to check for changes since a previous @@ -129,7 +129,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The date and time when the image or server was created. + Filters the response by the date and time when the resource was created. The date and time stamp format is '> + + + + Filters the response by the date and time when the resource was updated. + + + The date and time stamp format is ISO 8601: + + CCYY-MM-DDThh:mm:ss±hh:mm + + The ±hh:mm value, if included, is the time zone as an + offset from UTC. + + + For example, 2015-08-27T09:49:58-05:00. + + + If you omit the time zone, the UTC time zone is assumed. + + + If you omit the updated_at date and time stamp, its value + is null. + + +'> @@ -618,7 +648,7 @@ - The expiration date and time in UNIX Epoch time stamp format. 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 eec70ebf7..15952cf00 100644 --- a/api-ref/src/wadls/image-api/src/v2/common.ent +++ b/api-ref/src/wadls/image-api/src/v2/common.ent @@ -8,9 +8,9 @@ in every request. --> - - + + + @@ -35,1226 +35,1734 @@ '> - - + + + '> - - - - -'> - - - - Filter parameter. - - - Shows only images with this name. - - - A valid value is the name of the image as a string. - - - - - - - Filter parameter. - - - Shows only images with this image visibility value or values. - - - Valid values are public, private, and - shared. If you omit this parameter, the response shows - public, private, and shared - images with accepted member status. - - - - - - - Filter parameter. - - - Shows only images with this member status. - - - A valid value is accepted, pending, - rejected, or all. Default is - accepted. - - - - - - - Filters the response by a tenant ID. - - - Shows only images that are shared with this tenant owner. - - - - - - - Filter parameter. - - - Shows only images with this image status. - - - A valid value is queued, saving, - active, killed, deleted, or - pending_delete. - - - - - - - Filter parameter. - - - Shows only images with this minimum image size. - - - A valid value is the minimum size of the image, - in bytes. - - - - - - Filter parameter. - - - Shows only images with this maximum image size. - - A valid value is the maximum size of the image, - in bytes. - - - - - - - Sorts by the requested image attribute. Accepted values are - name, status, container_format, - disk_format, size, id, - created_at, and updated_at. Default is - created_at. The API uses the natural sorting direction of - the image attribute that is provided as the sort_key. - - - - - - - Sorts by one or more sets of attribute and sort direction combinations. - If you omit the sort direction in a set, the default is desc. - - - -&sortQueryParameter; - - - - Image tag. For example, ?tag="cirros". - - -'> - - - A list of image objects. - -'> - - - An image object. - -'> - - - The image status. - -'> - - - The name of the image. - - If this field has no value, its value is null (JSON null data type). - - -'> - - - - The container format of image. - - - If this field has no value, its value is null (JSON null data type). - - -'> - - - - The disk format of the image. - - - If this field has no value, its value is null (JSON null data type). - - -'> - - - - 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). - - -'> - - - Indicates whether the image can be deleted. - -'> - - - - The UUID of the image. - - -'> - - - - The minimum amount of RAM in MB that is required to boot the image. - - - If this field has no value, its value is null (JSON null - data type). - - -'> - - - Hash of the image data used. The Image service uses this value for - verification. - - - If this field has no value, its value is null (JSON null data type). - - -'> - - - The ID of the owner, or tenant, of the image. - - If this field has no value, its value is null (JSON null data type). - - -'> - - - The image visibility. - -'> - - - The virtual size of the image. - - If this field has no value, its value is null (JSON null data type). - - -'> - - - Properties, if any, that are associated with the image. - -'> - - - The size of the image data, in bytes. - - If this field has no value, its value is null (JSON null data type). - - -'> - - - - The UUID of the image. - - -'> - + + +'> + + + + - - - The content range of image data. For details, see Hypertext Transfer - Protocol (HTTP/1.1): Range Requests. - - + + + The content range of image data. For details, see Hypertext Transfer + Protocol (HTTP/1.1): Range Requests. + + '> - - - A list of Image tag. - + + + The URL to access the image file from the external store. + + '> - + + + + + + + Filters the response by a member status. + + + A valid value is accepted, pending, + rejected, or all. Default is + accepted. + + +'> + + + + Filters the response by a name, as a string. + + + A valid value is the name of an image. + + +'> + + + + Filters the response by a namespace visibility value. + + + A valid value is public or private. If you + omit this parameter, the response shows public and + private namespaces. + + +'> + + + + Filters the response by a tenant ID. + + + Shows only images that are shared with this tenant owner. + + +'> + + + + Filters the response by a resource type or types. + + + Use the comma (,) character to separate multiple values. + For example, OS::Glance::Image,OS::Nova::Flavor shows + only namespaces for these resource types. + + +'> + + + + Filters the response by property names that start with a prefix + from an associated resource type. + + + The API removes the prefix of the resource type from the property + name in the response. + + +'> + + + + Filters the response by a maximum image size, in bytes. + + +'> + + + + Filters the response by a minimum image size, in bytes. + + +'> + + + + Sorts the response by one or more attribute and sort direction + combinations. You can also set multiple sort keys and directions. + Default direction is desc. + + + Use the comma (,) character to separate multiple values. + For example: + +GET /v2/images?sort=name:asc,status:desc + +'> + + + + Sorts the response by a set of one or more sort direction and + attribute (sort_key) combinations. A valid value for the + sort direction is asc (ascending) or desc + (descending). If you omit the sort direction in a set, the default is + desc. + + +'> + + + + Sorts the response by an attribute, such as name, + id, or updated_at. Default is + created_at. The API uses the natural sorting direction + of the sort_key image attribute. + + +'> + + + + Filters the response by an image status. + + + A valid value is queued, saving, + active, killed, deleted, or + pending_delete. + + +'> + + + + Filters the response by a task status. A valid value is + pending, processing, success, + or failure. + + +'> + + + + Filters the response by an image tag. For example, + ?tag="cirros". + + +'> + + + + Filters the response by a task type. A valid value is + import. + + +'> + + + + Filters the response by an image visibility value or values. + + + Use the comma (,) character to separate multiple values. + A valid value is public, private, or + shared. If you omit this parameter, the response shows + public, private, and shared + images with a member status of accepted. + + +'> + + + + + + + + + + The UUID of the image. + + +'> + + + + The ID of the image member. An image member is a tenant with whom the + image is shared. + + +'> + + + + The UUID of the namespace. + + +'> + + + + The name of the object. + + +'> + + + + The name of the property. + + +'> + + + + Name of the resource type. + + +'> + - - Image tag. - + + + The image tag. + + +'> + + + + The name of the tag. + + +'> + + + + The UUID of the task. + + +'> + + + + + + + Describes extra items, if you use tuple typing. If the value + of items is an array (tuple typing) and the instance is + longer than the list of schemas in items, the additional + items are described by the schema in this property. + + + If this value is false, the instance cannot be longer than + the list of schemas in items. + + + If this value is true, that is equivalent to the empty + schema (anything goes). + + '> - - - Format of the container. A valid value is ami, - ari, aki, bare, - ovf, ova, or docker. - - + + + Format of the container. A valid value is ami, + ari, aki, bare, + ovf, ova, or docker. + + +'> + + + + Default property description. + + +'> + + + + Detailed description for the namespace. + + +'> + + + + The description of the property. + + '> - - - Format of the disk. A valid value is ami, ari, - aki, vhd, vmdk, raw, - qcow2, vdi, or iso. - - + + + The format of the disk. A valid value is ami, + ari, aki, vhd, + vmdk, raw, qcow2, + vdi, or iso. + + +'> + + + + User-friendly name to use in a UI to display the namespace name. + + +'> + + + + Enumerated list of property values. + + +'> + + + + A unique, user-defined image UUID, in the format: + + nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn + + Where n is a hexadecimal digit from 0 + to f, or F. + + + For example: + + b2173dd3-7ad6-4362-baa6-a68bce3565cb + + If you omit this value, the API generates a UUID for the + image. + + +'> + + + + An image object. + + +'> + + + + A list of image objects. + + +'> + + + + Schema for the items in an array. + + +'> + + + + Maximum allowed numerical value. + + +'> + + + + Maximum length of an array. + + +'> + + + + Maximum allowed string length. + + +'> + + + + The ID of the image member. An image member is a tenant with whom the + image is shared. + + + This call accepts either the member_id or + member attribute in the request body. If you specify + both attributes, the API uses the member_id value and + ignores the member value. Use of the member + attribute is supported but deprecated. Use of the + member_id attribute is preferred. + + +'> + + + + The ID of the image member. An image member is a tenant with whom the + image is shared. + + + This call accepts either the member_id or + member attribute in the request body. If you specify + both attributes, the API uses the member_id value and + ignores the member value. Use of the member + attribute is supported but deprecated. Use of the + member_id attribute is preferred. + + +'> + + + + A list of member objects. Each member + object describes a member with whom this image is being shared. + + +'> + + + + The URL for schema of the member. + + +'> + + + + The location metadata. + + '> - - Amount of disk space in GB that is required to boot the image. - + + + Amount of disk space in GB that is required to boot the image. + + +'> + + + + Minimum allowed numerical value. + + +'> + + + + Minimum length of an array. + + +'> + + + + Minimum allowed string length. + + '> - - Amount of RAM in MB that is required to boot the image. - + + + Amount of RAM in MB that is required to boot the image. + + '> - - - If true, image is not deletable. - + + + 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. + + '> - - - Properties, if any, that are associated with the image. - -'> - - - Image's property. - + + Name of the resource type. + '> - + + + A list of namespace objects. + + +'> + - - - Value of image property used in add or replace operations expressed in - JSON notation. For example, you must enclose strings in quotation marks, - and you do not enclose numeric values in quotation marks. - - + name="namespace" style="plain" type="xsd:string" + required="true"> + + + The namespace is unique across all users. + + '> - + + + Namespace object definitions, if any. + + +'> + - - The operation. A valid value is: - add. Adds a property or location in the - image. - - - remove. Removes an image's property or location. - - - replace. Replaces the value of an image's property or - location. - - + + + The operation. A valid value is: + + + + + add. Adds a property or location in the + image. + + + + + remove. Removes an image's property or location. + + + + + replace. Replaces the value of an image's + property or location. + + + + '> - + + + Operators property description. + + +'> + + + + An image property. + + +'> + + + + A regular expression (ECMA + 262) that a string value must match. + + +'> + + + + 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. + + +'> + + + + The image properties, if any. + + +'> + + + + Namespace property definitions, if any. + + +'> + + + + Some resource types allow more than one key and + value pair for each instance. For example, the + Image service allows both user and image metadata + on volumes. The properties_target + parameter enables a namespace target to remove the + ambiguity. + + +'> + + + + The name of the property. + + +'> + + + + Image protection for deletion. Valid value is true + or false. Default is false. + + +'> + + + + Namespace protection for deletion. Valid value is true + or false. Default is false. + + +'> + + + + Indicates whether this is a read-only property. + + +'> + + + + Namespace resource types, if any. + + +'> + + + + The image status. + + +'> + + + + The status of this image member. + + +'> + + + + A list of tag objects. + + +'> + + + + Image tags. + + + 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. + + + + + +'> + + + + The UUID of the task. + + +'> + + + + The title of the property. + + +'> + + + + The property type. + + +'> + + + + Indicates whether all values in the array must be distinct. + + +'> + - - URL to access the image file kept in external - store. - - + + + The URL to access the image file kept in external + store. + + '> - - - The location metadata. - + + + Value of image property used in add or replace operations expressed in + JSON notation. For example, you must enclose strings in quotation marks, + and you do not enclose numeric values in quotation marks. + + '> - + + + The virtual size of the image. + + +'> + - - URL to access the image file kept in external store. - + name="visibility" style="plain" type="xsd:string" + required="false"> + + + Namespace visibility. Valid value is public or + private. Default is private. + + '> - - - - A list of URLs to access the image file in external store. This list - appears if the show_multiple_locations option is set to - True in the Image service's configuration file. - - + name="visibility" style="plain" type="xsd:string" + required="false"> + + + Image visibility. Valid value is public or + private. Default is public. + + '> - + + + + + + Describes extra items, if you use tuple typing. If the value of + items is an array (tuple typing) and the instance is longer + than the list of schemas in items, the additional items are + described by the schema in this property. + + + If this value is false, the instance cannot be longer than + the list of schemas in items. + + + If this value is true, that is equivalent to the empty + schema (anything goes). + + +'> + + + + Hash that is used over the the image data. The Image service uses + this value for verification. + + + The value might be null (JSON null data type). + + +'> + + + + The container format of the image. + + + The value might be null (JSON null data type). + + +'> + + + + Default property description. + + +'> + + + + The description of the namespace. + + +'> + + + + The description of the property. + + +'> + - - URL to access the image file kept in external store. It - appears when you set the show_image_direct_url option - to True in the Image service's configuration - file. - - + + + The URL to access the image file kept in external store. It + appears when you set the show_image_direct_url option + to True in the Image service's configuration + file. + + '> - - - URL for schema of the virtual machine images. - + + + + The disk format of the image. + + + The value might be null (JSON null data type). + + '> - - - URL for the first page of response. - + + + + User-friendly name to use in a UI to display the namespace name. + + '> - - - URL for the virtual machine image. - + + + + An enumerated list of property values. + + '> - - - URL for the virtual machine image file. - + + + The URL for the virtual machine image file. + + '> - + + + The URL for the first page of response. + + +'> + + + + The UUID of the image. + + +'> + + + + The UUID of the image. + + +'> + - - URL for schema of the virtual machine image. - + + + The URL for schema of the virtual machine image. + + '> - + + + The URL for schema of the virtual machine images. + + +'> + + + + Schema for the items in an array. + + +'> + + + + A list of URLs to access the image file in external store. This list + appears if the show_multiple_locations option is set to + True in the Image service's configuration file. + + +'> + + + + Maximum allowed numerical value. + + +'> + + + + Maximum length of an array. + + +'> + + + + Maximum allowed string length. + + +'> + - - - Image member ID. For example, the tenant ID of the user with whom the - image is being shared. - - + style="plain" type="xsd:string" required="true"> + + + The ID of the image member. An image member is a tenant with whom the + image is shared. + + + This call accepts either the member_id or + member attribute in the request body. If you specify + both attributes, the API uses the member_id value and + ignores the member value. Use of the member + attribute is supported but deprecated. Use of the + member_id attribute is preferred. + + '> - - - - A list of member objects. Each member - object describes a member with whom this image is being shared. - - -'> - - + xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> + The URL for schema of the member. - + '> - - - + style="plain" type="xsd:string" required="true"> + + The URL for schema of the members. - + '> - - - - Filter parameter. - - - Shows only namespaces with this visibility value or values. - - - Valid values are public and private. If you - omit this parameter, the response shows public and - private namespaces. - - - - - - - Filter parameter. - - - Shows only namespaces with this resource type or - types. - - - Specify multiple values as a comma-separated list. For example, set the - resource_types filter to - OS::Glance::Image,OS::Nova::Flavor to include only - namespaces that are associated with this resource types. - - - - - - - Sort key. A valid value is an attribute, such as namespace, - for sorting. Default is created_at. - - - - - - Sort direction. A valid value is asc - (ascending) or desc (descending). Default is - desc. - - + + + + The location metadata. + + '> - + + + The minimum disk size in GB that is required to boot the image. + + + The value might be null (JSON null data type). + + +'> + - - A namespaces object. - + + + Minimum allowed numerical value. + + '> - - - - The UUID of the namespace. - - -' > - + + + Minimum length of an array. + + +'> + + + + Minimum allowed string length. + + +'> + + + + The minimum amount of RAM in MB that is required to boot the image. + + + The value might be null (JSON null + data type). + + +'> + + + + The name of the image. + + + Value might be null (JSON null data type). + + +'> + + + + The name of the property. + + +'> + + + + The name of the tag. + + +'> + + + + The name of the resource type. + + +'> + - - The namespace is unique across all users. - + + + The namespace is unique across all users. + + '> - - - User friendly name which could be used in UI for displaying namespace name. - -'> - - - Detailed description for the namespace. - -'> - - - - Namespace visibility. A valid value is public or - private. Default is private. - - -'> - - - - Namespace protection for deletion. A valid value is True or - False. Default is False. - - -'> - - - Property definition(s) of the namespace. - -'> - - - Object definition(s) of the namespace. - + + + One or more object definitions of the namespace. + + '> - - - Resource type(s) which are associated with this namespace. - + + + Operators property description. + + '> - - - Name of the resource type. - + + + The ID of the owner, or tenant, of the image. + + + The value might be null (JSON null data type). + + '> - - - - Specifies the prefix to use for the resource type. Prefix any properties - that you want to apply to the resource type in the namespace with this - prefix. Must include a prefix separator, such as the colon (:) character. - - + + + A regular expression (ECMA 262) that a string value must match. + + '> - - - Some resource types allow more than one key / value pair - per instance. For example, Cinder allows user and image - metadata on volumes. Only the image properties metadata - is evaluated by Nova (scheduling or drivers). This property - allows a namespace target to remove the ambiguity. - - + + + + A list of property objects. + + '> - - - The name of the property. - + + + + The image properties, if any. + + '> - - - A properties object. - + + + One or more property definitions for the namespace. + + '> - + + + Image protection for deletion. A valid value is True or + False. Default is False. + + +'> + - - The name of the property. - + + + Namespace protection for deletion. A valid value is True or + False. Default is False. + + '> - - - The title of the property. - -'> - - - The property type. - -'> - - - Enumeration of property values. - -'> - - - Enumeration of property values. - -'> - - - Schema for the items in an array. - -'> - - - Schema for the items in an array. - -'> - - - The description of the property. - -'> - - - The description of the property. - -'> - - - Operators property description. - -'> - - - Operators property description. - -'> - - - Default property description. - -'> - - - Default property description. - -'> - - - Indicates whether this is a read-only property. - + + + Indicates whether this is a read-only property. + + '> - - - Minimum allowed numerical value. - + + + One or more namespace resource types. + + '> - - - Maximum allowed numerical value. - + + + + The URL for the virtual machine image. + + '> - - - Minimum allowed string length. - + + + + The size of the image data, in bytes. + + + The value might be null (JSON null data type). + + '> - - - Maximum allowed string length. - -'> - - - A regular expression (ECMA 262) that a string value - must match. - - -'> - - - Minimum length of an array. - -'> - - - Maximum length of an array. - -'> - - - - Indicates whether all values in the array must be distinct. - - -'> - - - - Describes extra items, if you use tuple typing. If the value of - items is an array (tuple typing) and the instance is longer - than the list of schemas in items, the additional items are - described by the schema in this property. - - - If this value is false, the instance cannot be longer than - the list of schemas in items. - - - If this value is true, that is equivalent to the empty - schema (anything goes). - - -'> - - - Default property description. - -'> - - - Indicates whether this is a read-only property. - -'> - - - Minimum allowed numerical value. - -'> - - - Maximum allowed numerical value. - -'> - - - Minimum allowed string length. - -'> - - - Maximum allowed string length. - -'> - - - A regular expression (ECMA 262) that a string value - must match. - - -'> - - - Minimum length of an array. - -'> - - - Maximum length of an array. - -'> - - - - Indicates whether all values in the array must be distinct. - - -'> - - - - Describes extra items, if you use tuple typing. If the value of - items is an array (tuple typing) and the instance is longer - than the list of schemas in items, the additional items are - described by the schema in this property. - - - If this value is false, the instance cannot be longer than - the list of schemas in items. - - - If this value is true, that is equivalent to the empty - schema (anything goes). - - -'> - - - A list of tag dictionary objects. - -'> - - - Name of the tag. - -'> - - - - Sort key. A valid value is an attribute, such as name. for - sorting. Default is created_at. - - - - - - Sort direction. A valid value is asc - (ascending) or desc (descending). Default is - desc. - - -'> - - - - Filters by a task type. A valid value is import. - - - + - - - Filters by a task status. A valid value is - pending, processing, success, or - failure. - - - - - - - Sort key. A valid value is an attribute, such as name, for - sorting. Default is created_at. - - - - - - Sort direction. A valid value is asc - (ascending) or desc (descending). Default is - desc. - - + style="plain" required="true" type="xsd:string"> + + + The image status. + + '> - - - - The UUID of the task. - - + + + + The title of the property. + + +'> + + + + The property type. + + +'> + + + + Indicates whether all values in the array must be distinct. + + +'> + + + The virtual size of the image. + + The value might be null (JSON null data type). + + +'> + + + + The namespace visibility. A valid value is public or + private. Default is private. + + +'> + + + + The image visibility. A valid value is public or + private. Default is private. + + '> diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl index 4156277ce..2fd8c1552 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl @@ -38,7 +38,7 @@ - &image_idParameter; + &image_idTemplateParameter; @@ -56,7 +56,7 @@ - &tagParameter; + &tagTemplateParameter; @@ -64,7 +64,7 @@ - &member_idParameter; + &member_idTemplateParameter; @@ -76,6 +76,7 @@ + &task_idTemplateParameter; @@ -97,8 +98,7 @@ - Lists information about available Image - service API versions. + Lists version information for all Image service API versions. @@ -114,7 +114,8 @@ - (Since Image API v2.0) Lists public virtual machine (VM) + + (Since Image API v2.0) Lists public virtual machine (VM) images. @@ -130,15 +131,14 @@ marker parameters. - The list operation accepts several query parameters. Use these - parameters to filter the response. + The list operation accepts query parameters to filter the response. A client can provide direct comparison filters by using most image attributes, such as name=Ubuntu, 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. + 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 @@ -162,8 +162,8 @@ - sort_key. Sorts by an image - attribute. Sorts in the natural sorting direction of the image attribute. + sort_key. Sorts by an image attribute. Sorts in + the natural sorting direction of the image attribute. @@ -179,18 +179,20 @@ - To specify the sort_key and - sort_dir query parameters to sort the results: + + To sort the response, use the sort_key and + sort_dir query parameters: 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: + + Alternatively, specify the sort query parameter: GET /v2/images?sort=name:asc,status:desc &limitMarkerReqParameter; - &imageListReqParameters; + &imageListQueryParameters; @@ -200,39 +202,51 @@ - &imagesParameter; &statusParameter; - &nameParameter; &tagsParameter; &container_formatParameter; - &created_at-ResponseParameter; &disk_formatParameter; - &updated_at-ResponseParameter; &min_diskParameter; - &protectedParameter; &idParameter; &min_ramParameter; - &checksumParameter; &ownerParameter; - &visibilityParameter; &virtual_sizeParameter; - &sizeParameter; &propertiesParameter; - &location_urlParameter; &metadataParameter; - &direct_urlParameter; &selfParameter; - &fileParameter; &image_schemaParameter; - &images_schemaParameter; - &firstParameter; + &imagesObjectParameter; + &statusResponseParameter; + &image-nameResponseParameter; + &tagsObjectParameter; + &container_formatResponseParameter; + &created_at-ResponseParameter; + &disk_formatResponseParameter; + &updated_at-ResponseParameter; + &min_diskResponseParameter; + &image-protectedResponseParameter; + &idResponseParameter; + &min_ramResponseParameter; + &checksumResponseParameter; + &owner_idResponseParameter; + &image-visibilityResponseParameter; + &virtual_sizeResponseParameter; + &sizeResponseParameter; + &image-propertiesResponseParameter; + &locationsResponseParameter; + &metadataResponseParameter; + &direct_urlResponseParameter; + &selfResponseParameter; + &fileResponseParameter; + &image-schemaResponseParameter; + &images-schemaResponseParameter; + &firstResponseParameter; - (Since Image API v2.0) Creates a virtual machine (VM) - image. + + (Since Image API v2.0) Creates a virtual machine (VM) image. - The response includes a Location response header that - contains the URI for the image. The response body contains the new - image entity. + The Location response header contains the URI for + the image. The response body contains the new image entity. Synchronous Postconditions - With correct permissions, you can see - the image status as queued through API - calls. + + With correct permissions, you can see the image status as + queued through API calls. @@ -244,70 +258,16 @@ xmlns="http://docbook.org/ns/docbook"> - - - - 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. - - - - - - - A unique, user-defined image UUID, in the format: - -nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn - - Where n is a hexadecimal digit from 0 - to f, or F. - - - For example: - - b2173dd3-7ad6-4362-baa6-a68bce3565cb - - If you omit this value, the API generates a UUID for the - image. - - - - - - - Image visibility. Public or private. - Default is public. - - - - - - - Image tags. - - - - &container_formatRequestParameter; &disk_formatRequestParameter; - &min_diskRequestParameter; &min_ramRequestParameter; - &protectedRequestParameter; &propertiesRequestParameter; + &image-nameRequestParameter; + &idRequestParameter; + &image-visibilityRequestParameter; + &tagsRequestParameter; + &container_formatRequestParameter; + &disk_formatRequestParameter; + &min_diskRequestParameter; + &min_ramRequestParameter; + &image-protectedRequestParameter; + &image-propertiesRequestParameter; @@ -317,16 +277,27 @@ - &statusParameter; &container_formatParameter; - &min_ramParameter; &updated_at-ResponseParameter; - &ownerParameter; &min_diskParameter; - &tagsParameter; &visibilityParameter; - &idParameter; &sizeParameter; &virtual_sizeParameter; - &nameParameter; &checksumParameter; - &created_at-ResponseParameter; &disk_formatParameter; - &propertiesParameter; &protectedParameter; - &locationParameter; &selfParameter; - &fileParameter; &image_schemaParameter; + &statusResponseParameter; + &container_formatResponseParameter; + &min_ramResponseParameter; + &updated_at-ResponseParameter; + &owner_idResponseParameter; + &min_diskResponseParameter; + &tagsObjectParameter; + &image-visibilityResponseParameter; + &idResponseParameter; + &sizeResponseParameter; + &virtual_sizeResponseParameter; + &image-nameResponseParameter; + &checksumResponseParameter; + &created_at-ResponseParameter; + &disk_formatResponseParameter; + &image-propertiesResponseParameter; + &image-protectedResponseParameter; + &locationRequestHeader; + &selfResponseParameter; + &fileResponseParameter; + &image-schemaResponseParameter; @@ -408,8 +379,8 @@ - The root of the target document. The value is the - entire content of the target document. + The root of the target document. The value is the entire + content of the target document. @@ -519,8 +490,11 @@ xmlns="http://docbook.org/ns/docbook"> - &pathParameter; &valueParameter; &opParameter; - &urlParameter; &metadataParameter; + &pathRequestParameter; + &valueRequestParameter; + &opRequestParameter; + &urlRequestParameter; + &metadataRequestParameter; @@ -530,29 +504,46 @@ - &statusParameter; - &nameParameter; &tagsParameter; &container_formatParameter; - &created_at-ResponseParameter; &disk_formatParameter; - &updated_at-ResponseParameter; &min_diskParameter; - &protectedParameter; &idParameter; &min_ramParameter; - &checksumParameter; &ownerParameter; - &visibilityParameter; &sizeParameter; - &location_urlParameter; &metadataParameter; - &propertiesParameter; &direct_urlParameter; &selfParameter; - &fileParameter; &image_schemaParameter; + &statusResponseParameter; + &image-nameResponseParameter; + &tagsObjectParameter; + &container_formatResponseParameter; + &created_at-ResponseParameter; + &disk_formatResponseParameter; + &updated_at-ResponseParameter; + &min_diskResponseParameter; + &image-protectedResponseParameter; + &idResponseParameter; + &min_ramResponseParameter; + &checksumResponseParameter; + &owner_idResponseParameter; + &image-visibilityResponseParameter; + &sizeResponseParameter; + &locationsResponseParameter; + &metadataResponseParameter; + &image-propertiesResponseParameter; + &direct_urlResponseParameter; + &selfResponseParameter; + &fileResponseParameter; + &image-schemaResponseParameter; - (Since Image API v2.0) Shows details for an image. + + (Since Image API v2.0) Shows details for an image. + + + The response body contains a single image entity. - The response body contains a single image entity. Preconditions - The image must exist. + + The image must exist. + @@ -563,16 +554,28 @@ - &statusParameter; - &nameParameter; &tagsParameter; &container_formatParameter; - &created_at-ResponseParameter; &disk_formatParameter; - &updated_at-ResponseParameter; &min_diskParameter; - &protectedParameter; &idParameter; &min_ramParameter; - &checksumParameter; &ownerParameter; - &visibilityParameter; &sizeParameter; - &location_urlParameter; &metadataParameter; - &propertiesParameter; &direct_urlParameter; &selfParameter; - &fileParameter; &image_schemaParameter; + &statusResponseParameter; + &image-nameResponseParameter; + &tagsObjectParameter; + &container_formatResponseParameter; + &created_at-ResponseParameter; + &disk_formatResponseParameter; + &updated_at-ResponseParameter; + &min_diskResponseParameter; + &image-protectedResponseParameter; + &idResponseParameter; + &min_ramResponseParameter; + &checksumResponseParameter; + &owner_idResponseParameter; + &image-visibilityResponseParameter; + &sizeResponseParameter; + &locationsResponseParameter; + &metadataResponseParameter; + &image-propertiesResponseParameter; + &direct_urlResponseParameter; + &selfResponseParameter; + &fileResponseParameter; + &image-schemaResponseParameter; &fault404; @@ -580,7 +583,8 @@ - (Since Image API v2.0) Reactivates an image. + + (Since Image API v2.0) Reactivates an image. The reactivate operation returns an error if the image status is @@ -606,7 +610,8 @@ - (Since Image API v2.0) Deactivates an image. + + (Since Image API v2.0) Deactivates an image. If you try to download a deactivated image, the call returns the @@ -703,14 +708,15 @@ - (Since - Image API v2.0) Uploads binary image data. + + (Since Image API v2.0) Uploads binary image data. Set the Content-Type request header to application/octet-stream. - Example call: + + Example call: curl -i -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" \ -d @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file @@ -731,11 +737,13 @@ - The image status must be queued. + + The image status must be queued. - Your image storage quota must be sufficient. + + Your image storage quota must be sufficient. @@ -748,7 +756,8 @@ Synchronous Postconditions - With correct permissions, you can see the + + With correct permissions, you can see the image status as active through API calls. @@ -800,22 +809,23 @@ Preconditions - The images must exist. + + The images must exist. + Synchronous Postconditions - You can download the binary image data - in your machine if the image has image - data. + You can download the binary image data in your machine if + the image has image data. - If image data exists, the call returns the - HTTP 200 response code. + If image data exists, the call returns the HTTP + 200 response code. @@ -828,7 +838,7 @@ - &Content-RangeParameter; + &Content-RangeRequestHeader; @@ -857,8 +867,11 @@ - (Since Image API v2.2) Shows image member details. - Response body is a single image member entity. + + (Since Image API v2.2) Shows image member details. + + + Response body is a single image member entity. Preconditions @@ -881,7 +894,12 @@ href="../samples/image-member-details-response.json" /> - + &statusResponseParameter; + &created_at-ResponseParameter; + &updated_at-ResponseParameter; + &image_idResponseParameter; + &member_idResponseParameter; + &member-schemaResponseParameter; @@ -908,8 +926,7 @@ - You must be the owner or a member of - the image. + You must be the owner or a member of the image. @@ -922,11 +939,12 @@ href="../samples/image-members-list-response.json" /> - - &membersParameter; &statusParameter; - &created_at-ResponseParameter; &updated_at-ResponseParameter; - &image_idParameter; &member_idParameter; - &member_schemaParameter; &members_schemaParameter; + &membersObjectParameter; + &statusResponseParameter; + &created_at-ResponseParameter; + &updated_at-ResponseParameter; + &member-schemaResponseParameter; + &members-schemaResponseParameter; @@ -937,6 +955,14 @@ (Since Image API v2.1) Adds a tenant ID as an image member. + + This call accepts either the member_id or + member attribute in the request body. If you specify + both attributes, the API uses the member_id value and + ignores the member value. Use of the + member attribute is supported but deprecated. Use of + the member_id attribute is preferred. + Preconditions @@ -945,23 +971,21 @@ - You can only add a member to an image that has a - visibility attribute set to - private. + You can add a member to a private image. - You must be the owner of the - image. + + You must be the owner of the image. Synchronous Postconditions - With correct permissions, you can see - the member status of the image as pending - through API calls. + + With correct permissions, you can see the member status of + the image as pending through API calls. @@ -995,6 +1019,8 @@ href="../samples/image-member-create-request.json" /> + &member_idRequestParameter; + &memberRequestParameter; @@ -1005,7 +1031,12 @@ href="../samples/image-member-create-response.json" /> - + &created_at-ResponseParameter; + &image_idTemplateParameter; + &member_idResponseParameter; + &member-schemaResponseParameter; + &statusResponseParameter; + &updated_at-ResponseParameter; @@ -1063,17 +1094,7 @@ href="../samples/image-member-update-request.json" /> - - - - The status of this image member. - - - + &member-statusRequestParameter; @@ -1084,7 +1105,12 @@ href="../samples/image-member-update-response.json" /> - + &created_at-ResponseParameter; + &image_idTemplateParameter; + &member_idResponseParameter; + &member-schemaResponseParameter; + &statusResponseParameter; + &updated_at-ResponseParameter; @@ -1131,7 +1157,8 @@ - &fault403; &fault404; + &fault403; + &fault404; - &tasksShowParameters; + &task_idRequestParameter; @@ -1195,5 +1222,5 @@ - + diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl index a41b89f82..332fd30c2 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl @@ -35,19 +35,13 @@ - + + &namespace_idTemplateParameter; - &metadefNamespace_idParameter; - - - The name of the object. - - + &object_nameTemplateParameter; @@ -76,80 +70,14 @@ xmlns="http://docbook.org/ns/docbook"> - - - - The namespace is unique across all users. - - - - - User-friendly name to use in a UI to display the namespace name. - - - - Detailed description for the namespace. - - - - - Namespace visibility. Public or private. - Default is private. - - - - - Namespace protection for deletion. Valid value is true or false. - Default is false. - - - - - Property definitions, if any, for the namespace. - - - - - Object definitions, if any, for the namespace. - - - - - Resource types, if any, that are associated with this namespace - - + &namespaceRequestParameter; + &display_nameRequestParameter; + &namespace-descriptionRequestParameter; + &namespace-visibilityRequestParameter; + &namespace-protectedRequestParameter; + &namespace-propertiesRequestParameter; + &objectRequestParameter; + &resource_type_associationsRequestParameter; @@ -158,10 +86,15 @@ xmlns="http://docbook.org/ns/docbook"> - &metadefNamespaceParameter; &metadefNSDisplayNameParameter; - &metadefNSDescParameter; &metadefNSVisibilityParameter; - &metadefNSProtectedParameter; &metadefPropertiesParameter; - &metadefObjectsParameter; &metadefResTypeAssocsParameter; + + &namespaceResponseParameter; + &display_nameResponseParameter; + &namespace-descriptionResponseParameter; + &namespace-visibilityResponseParameter; + &namespace-protectedResponseParameter; + &namespace-propertiesResponseParameter; + &objectsResponseParameter; + &resource_type_associationsResponseParameter; @@ -204,7 +137,8 @@ - &metadefNamespaceListReqParameters; + &metadefNamespaceListQueryParameters; + @@ -212,10 +146,15 @@ xmlns="http://docbook.org/ns/docbook"> - &namespacesParameter; &metadefNamespaceParameter; - &metadefNSDisplayNameParameter; &metadefNSDescParameter; - &metadefNSVisibilityParameter; &metadefNSProtectedParameter; - &metadefResTypeAssocsParameter; + + &namespacesObjectParameter; + &namespaceResponseParameter; + &display_nameResponseParameter; + &namespace-descriptionResponseParameter; + &namespace-visibilityResponseParameter; + &namespace-protectedResponseParameter; + &resource_type_associationsResponseParameter; + diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl index fcc0b3dce..9624cff51 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl @@ -35,12 +35,14 @@ - + + &namespace_idTemplateParameter; + &property_nameTemplateParameter; @@ -72,17 +74,24 @@ xmlns="http://docbook.org/ns/docbook"> - &metadefPropertyNameParameter; - &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; - &metadefPropertyEnumOptionalParameter; &metadefPropertyItemsOptionalParameter; - &metadefPropertyDescOptionalParameter; &metadefPropertyOperOptionalParameter; - &metadefPropertyDfltOptionalParameter; &metadefPropertyReadOptionalParameter; - &metadefPropertyMinOptionalParameter; - &metadefPropertyMaxOptionalParameter; &metadefPropertyMinLengthOptionalParameter; - &metadefPropertyMaxLengthOptionalParameter; &metadefPropertyPatternOptionalParameter; - &metadefPropertyMinItemsOptionalParameter; &metadefPropertyMaxItemsOptionalParameter; - &metadefPropertyUniqueItemsOptionalParameter; - &metadefPropertyAdditionalItemsOptionalParameter; + &property-nameResponseParameter; + &titleResponseParameter; + &typeResponseParameter; + &enumRequestParameter; + &itemsRequestParameter; + &property-descriptionRequestParameter; + &operatorsRequestParameter; + &defaultRequestParameter; + &readonlyRequestParameter; + &minimumRequestParameter; + &maximumRequestParameter; + &minLengthRequestParameter; + &maxLengthRequestParameter; + &patternRequestParameter; + &minItemsRequestParameter; + &maxItemsRequestParameter; + &uniqueItemsRequestParameter; + &additionalItemsRequestParameter; @@ -91,17 +100,25 @@ xmlns="http://docbook.org/ns/docbook"> - &metadefPropertyNameParameter; - &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; - &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; - &metadefPropertyDescParameter; &metadefPropertyOperParameter; - &metadefPropertyDfltParameter; &metadefPropertyReadParameter; - &metadefPropertyMinParameter; - &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; - &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; - &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; - &metadefPropertyUniqueItemsParameter; - &metadefPropertyAdditionalItemsParameter; + + &property-nameResponseParameter; + &titleResponseParameter; + &typeResponseParameter; + &enumResponseParameter; + &itemsResponseParameter; + &property-descriptionResponseParameter; + &operatorsResponseParameter; + &defaultResponseParameter; + &readonlyResponseParameter; + &minimumResponseParameter; + &maximumResponseParameter; + &minLengthResponseParameter; + &maxLengthResponseParameter; + &patternResponseParameter; + &minItemsResponseParameter; + &maxItemsResponseParameter; + &uniqueItemsResponseParameter; + &additionalItemsResponseParameter; @@ -112,28 +129,32 @@ Lists property definitions in a namespace. - - - &metadefNamespace_idParameter; - - &metadefPropertyListParameter; - &metadefPropertyNameParameter; - &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; - &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; - &metadefPropertyDescParameter; &metadefPropertyOperParameter; - &metadefPropertyDfltParameter; &metadefPropertyReadParameter; - &metadefPropertyMinParameter; - &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; - &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; - &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; - &metadefPropertyUniqueItemsParameter; - &metadefPropertyAdditionalItemsParameter; + + &propertiesObjectParameter; + &property-nameResponseParameter; + &titleResponseParameter; + &typeResponseParameter; + &enumResponseParameter; + &itemsResponseParameter; + &property-descriptionResponseParameter; + &operatorsResponseParameter; + &defaultResponseParameter; + &readonlyResponseParameter; + &minimumResponseParameter; + &maximumResponseParameter; + &minLengthResponseParameter; + &maxLengthResponseParameter; + &patternResponseParameter; + &minItemsResponseParameter; + &maxItemsResponseParameter; + &uniqueItemsResponseParameter; + &additionalItemsResponseParameter; @@ -156,26 +177,9 @@ - &metadefNamespace_idParameter; - &metadefPropertyNameIdParameter; - - - - Filter parameter. - - - Shows only property names that start with a prefix - from an associated resource type. - - - The API removes the prefix of the resource type - from the property name in the response. - - - - + &property_nameRequestParameter; + &resource_typeQueryParameter; + @@ -184,17 +188,24 @@ - &metadefPropertyNameParameter; - &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; - &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; - &metadefPropertyDescParameter; &metadefPropertyOperParameter; - &metadefPropertyDfltParameter; &metadefPropertyReadParameter; - &metadefPropertyMinParameter; - &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; - &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; - &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; - &metadefPropertyUniqueItemsParameter; - &metadefPropertyAdditionalItemsParameter; + &property-nameResponseParameter; + &titleResponseParameter; + &typeResponseParameter; + &enumResponseParameter; + &itemsResponseParameter; + &property-descriptionResponseParameter; + &operatorsResponseParameter; + &defaultResponseParameter; + &readonlyResponseParameter; + &minimumResponseParameter; + &maximumResponseParameter; + &minLengthResponseParameter; + &maxLengthResponseParameter; + &patternResponseParameter; + &minItemsResponseParameter; + &maxItemsResponseParameter; + &uniqueItemsResponseParameter; + &additionalItemsResponseParameter; @@ -212,183 +223,24 @@ xmlns="http://docbook.org/ns/docbook"> - - Name of the property. - - - - Property title. - - - - Property type - - - - - Enumeration of property values. - - - - - specifies schema for the items in an - array. - - - - - Property description. - - - - - Operators property description. - - - - - Default property description. - - - - - Indicates whether this is a read-only property. - - - - - Minimum allowed numerical value. - - - - - Maximum allowed numerical value. - - - - - Minimum allowed string length. - - - - - Maximum allowed string length. - - - - - A regular expression (ECMA 262) that - a string value must match. - - - - - Minimum length of an array. - - - - - Maximum length of an array. - - - - - whether all the values in the array - must be distinct. - - - - - - If you use tuple-typing, describes extra - items. If the value of items is an - array and the instance is longer than the list of - schema in items, the schema in this - property describes the additional items. - - - If this value is false, the instance cannot be - longer than the number of schemas that are listed in - items. - - - A value of true indicates an empty schema, or - anything goes. - - - + &property_nameRequestParameter; + &titleRequestParameter; + &typeRequestParameter; + &enumRequestParameter; + &itemsRequestParameter; + &property-descriptionRequestParameter; + &operatorsRequestParameter; + &defaultRequestParameter; + &readonlyRequestParameter; + &minimumRequestParameter; + &maximumRequestParameter; + &minLengthRequestParameter; + &maxLengthRequestParameter; + &patternRequestParameter; + &minItemsRequestParameter; + &maxItemsRequestParameter; + &uniqueItemsRequestParameter; + &additionalItemsRequestParameter; @@ -398,17 +250,24 @@ - &metadefPropertyNameParameter; - &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; - &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; - &metadefPropertyDescParameter; &metadefPropertyOperParameter; - &metadefPropertyDfltParameter; &metadefPropertyReadParameter; - &metadefPropertyMinParameter; - &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; - &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; - &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; - &metadefPropertyUniqueItemsParameter; - &metadefPropertyAdditionalItemsParameter; + &property-nameResponseParameter; + &titleResponseParameter; + &typeResponseParameter; + &enumResponseParameter; + &itemsResponseParameter; + &property-descriptionResponseParameter; + &operatorsResponseParameter; + &defaultResponseParameter; + &readonlyResponseParameter; + &minimumResponseParameter; + &maximumResponseParameter; + &minLengthResponseParameter; + &maxLengthResponseParameter; + &patternResponseParameter; + &minItemsResponseParameter; + &maxItemsResponseParameter; + &uniqueItemsResponseParameter; + &additionalItemsResponseParameter; @@ -416,8 +275,7 @@ - Removes a property definition in a - namespace. + Removes a property definition in a namespace. To remove a property, first make an update namespace request @@ -434,8 +292,8 @@ - &metadefNamespace_idParameter; - &metadefPropertyNameIdParameter; + &property_nameRequestParameter; + diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl index 7490f2c1b..3c46e0679 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl @@ -35,12 +35,14 @@ - - + + + &namespace_idTemplateParameter; - + + &tag_nameTemplateParameter; @@ -70,9 +72,9 @@ - &metadefNamespaceParameter; - &metadefTagsParameter; - &metadefTagNameParameter; + &namespaceResponseParameter; + &tagsObjectParameter; + &tag-nameResponseParameter; @@ -82,8 +84,8 @@ - &metadefTagsParameter; - &metadefTagNameParameter; + &tagsObjectParameter; + &tag-nameResponseParameter; @@ -102,9 +104,10 @@ - &metadefNamespaceParameter; + &namespaceResponseParameter; &limitMarkerReqParameter; - &metadefTagListSortParameters; + &metadefTagListQueryParameters; + @@ -113,8 +116,8 @@ - &metadefTagsParameter; - &metadefTagNameParameter; + &tagsObjectParameter; + &tag-nameResponseParameter; @@ -137,7 +140,7 @@ - &metadefNamespaceParameter; + &namespaceResponseParameter; @@ -150,19 +153,14 @@ Adds a tag to the list of namespace tag definitions. - - - &metadefNamespaceParameter; - &metadefTagNameParameter; - - - &metadefTagNameParameter; + + &tag-nameResponseParameter; @@ -174,19 +172,14 @@ The response body shows a single tag entity. - - - &metadefNamespaceParameter; - &metadefTagNameParameter; - - - &metadefTagNameParameter; + + &tag-nameResponseParameter; @@ -203,8 +196,6 @@ xmlns="http://docbook.org/ns/docbook"> - &metadefNamespaceParameter; - &metadefTagNameParameter; @@ -214,7 +205,7 @@ - &metadefTagNameParameter; + &tag-nameResponseParameter; @@ -235,12 +226,6 @@ The response is empty and returns the HTTP 204 status code. - - - &metadefNamespaceParameter; - &metadefTagNameParameter; - - diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl index 30aa4b393..635f15192 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl @@ -37,17 +37,8 @@ - - - - - Unique namespace. - - - + + &namespace_idTemplateParameter; @@ -78,98 +69,14 @@ xmlns="http://docbook.org/ns/docbook"> - - - - A namespace name that is unique across all users. - - - - - - - User-friendly name that you can use in the UI to - display the namespace name. - - - - - - - Detailed description for the namespace. - - - - - - - Namespace visibility. Valid value is public or - private. Default is private. - - - - - - - Namespace protection for deletion. Valid value is - true or false. Default is false. - - - - - - - One or more property definitions in the namespace. - - - - - - - One or more object definitions in the namespace. - - - - - - - One or more resource types that are associated - with this namespace. - - - + @@ -179,10 +86,14 @@ - &metadefNamespaceParameter; &metadefNSDisplayNameParameter; - &metadefNSDescParameter; &metadefNSVisibilityParameter; - &metadefNSProtectedParameter; &metadefPropertiesParameter; - &metadefObjectsParameter; &metadefResTypeAssocsParameter; + &namespaceResponseParameter; + &display_nameResponseParameter; + &namespace-descriptionResponseParameter; + &namespace-visibilityResponseParameter; + &namespace-protectedResponseParameter; + &namespace-propertiesResponseParameter; + &objectsResponseParameter; + &resource_type_associationsResponseParameter; @@ -219,47 +130,10 @@ &limitMarkerReqParameter; - - - Filter parameter. Namespace visibility. Valid values are - public and private. - Default is public. - - - - - - - Filter parameter. Specify this value as comma-separated list. For - example, send the resource_types filter of - OS::Glance::Image,OS::Nova::Flavor to filter the namespaces - by those resource types. - - - - - - Sort key. Use attributes like namespace - for sorting. Default is created_at. - - - - - - Sort direction. Valid values are asc - (ascending) and desc (descending). Default is - desc. - - - + &visibilityQueryParameter; + &resource_typesQueryParameter; + &sort_keyQueryParameter; + &sort_dirQueryParameter; @@ -269,10 +143,13 @@ - &namespacesParameter; &metadefNamespaceParameter; - &metadefNSDisplayNameParameter; &metadefNSDescParameter; - &metadefNSVisibilityParameter; &metadefNSProtectedParameter; - &metadefResTypeAssocsParameter; + &namespacesObjectParameter; + &namespaceResponseParameter; + &display_nameResponseParameter; + &namespace-descriptionResponseParameter; + &namespace-visibilityResponseParameter; + &namespace-protectedResponseParameter; + &resource_type_associationsResponseParameter; @@ -300,7 +177,9 @@ - Updates a namespace. + + Updates a namespace. + @@ -308,7 +187,6 @@ xmlns="http://docbook.org/ns/docbook"> - &metadefNamespace_idParameter; @@ -325,13 +203,13 @@ - Deletes a namespace and its properties, - objects, and any resource type associations. + Deletes a namespace and its properties, objects, and any + resource type associations. You cannot delete namespaces with the protected - attribute set to true (boolean); the response returns the HTTP - 403 status code. + attribute set to true (boolean); the response returns the HTTP + 403 response code. To delete a namespace, you must first make an update namespace @@ -339,14 +217,14 @@ (boolean) on the namespace. Then, delete the namespace. - If the operation succeeds, the response returns the HTTP 204 - status code. + A successful operation returns the HTTP 204 + response code. If you try to remove a namespace with the protected attribute set to true (boolean), the - operation fails and the response returns the HTTP 403 error - code. + operation fails and the response returns the HTTP + 403 response code. diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl index e41283d0a..a9e836bc5 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl @@ -34,34 +34,17 @@ xml:id="os-metadef-resourcetype-v2"> - + - - - - - - Unique namespace. - - - + + &namespace_idTemplateParameter; + - - - Name of the resource type. - - + &resource-type-nameTemplateParameter; @@ -77,8 +60,9 @@ - Creates a resource type association - in a namespace. + + Creates a resource type association in a namespace. + - - - Name of 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. - - - - - - - Some resource types allow more than one key and - value pair for each instance. For example, the - Image service allows both user and image metadata - on volumes. The properties_target - parameter enables a namespace target to remove the - ambiguity. - - - + &resource-type-nameRequestParameter; + &prefixRequestParameter; + &properties_targetRequestParameter; @@ -143,11 +90,13 @@ - Lists resource types. + + Lists all resource types. + - Lists all possible resource types. You can assign metadata - definition namespaces to these resource types. See the - metadata definition resource types section. + You can assign metadata definition namespaces to these + resource types. See the metadata definition resource types + section. diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl index 78beea2ad..33299f120 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl @@ -39,61 +39,49 @@ - + - + - + - + - + - + - + - + - + - + - - - Shows a JSON schema document that represents a metadata - definition namespace entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents + a metadata definition namespace entity. The following schema document is an example. The authoritative @@ -115,8 +103,8 @@ - Shows a JSON schema document that represents a metadata - definition namespaces entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition namespaces entity. A namespaces entity is a container for namespace entities. @@ -141,8 +129,8 @@ - Shows a JSON schema document that represents a metadata - definition object entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition object entity. The following schema document is an example. The authoritative @@ -164,8 +152,8 @@ - Shows a JSON schema document that represents a metadata - definition objects entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition objects entity. An objects entity is a container for object entities. @@ -190,8 +178,8 @@ - Shows a JSON schema document that represents a metadata - definition property entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition property entity. The following schema document is an example. The authoritative @@ -213,8 +201,8 @@ - Shows a JSON schema document that represents a metadata - definition properties entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition properties entity. A properties entity is a container for property entities. @@ -239,8 +227,8 @@ - Shows a JSON schema document that represents a metadata - definition tag entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition tag entity. The following schema document is an example. The authoritative @@ -262,8 +250,8 @@ - Shows a JSON schema document that represents a metadata - definition tags entity. (Since API v2.1.) + (Since API v2.1) Shows a JSON schema document that represents a metadata + definition tags entity. A tags entity is a container for tag entities. @@ -288,9 +276,8 @@ - Shows a JSON schema document that represents a metadata + (Since API v2.1) Shows a JSON schema document that represents a metadata definition namespace resource type association entity. - (Since API v2.1.) The following schema document is an example. The authoritative @@ -312,9 +299,8 @@ - Shows a JSON schema document that represents a metadata + (Since API v2.1) Shows a JSON schema document that represents a metadata definition namespace resource type associations entity. - (Since API v2.1.) A resource type associations entity is a container for diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl index 8cd8badeb..45d0f876d 100644 --- a/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl @@ -27,50 +27,45 @@ - - - + - + - + - + - - - Shows a JSON schema document that - represents an images entity. (Since Images - v2.0.) - An images entity is a container of image - entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + + (Since Images v2.0) Shows a JSON schema document that + represents an images entity. + + + An images entity is a container of image entities. + + + The following schema is solely an example. Consider only the + response to the API call as authoritative. + @@ -86,12 +81,14 @@ - Shows a JSON schema document that - represents an image entity. (Since Images - v2.0.) - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + + (Since Images v2.0) Shows a JSON schema document that + represents an image entity. + + + The following schema is solely an example. Consider only the + response to the API call as authoritative. + @@ -107,14 +104,18 @@ - Shows a JSON schema document that - represents an image members entity. (Since Images - v2.1.) - An image members entity is a container of image - member entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + + (Since Images v2.1) Shows a JSON schema document that + represents an image members entity. + + + An image members entity is a container of image member + entities. + + + The following schema is solely an example. Consider only the + response to the API call as authoritative. + @@ -130,12 +131,14 @@ - Shows a JSON schema document that - represents an image member entity. (Since Images - v2.1.) - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + + (Since Images v2.1) Shows a JSON schema document that + represents an image member entity. + + + The following schema is solely an example. Consider only the + response to the API call as authoritative. + diff --git a/api-ref/src/wadls/volume-api/src/common.ent b/api-ref/src/wadls/volume-api/src/common.ent index 3167fff51..ccd29709d 100644 --- a/api-ref/src/wadls/volume-api/src/common.ent +++ b/api-ref/src/wadls/volume-api/src/common.ent @@ -2174,6 +2174,8 @@ +&availability_zoneResponseParameter; +&created_at-ResponseParameter; @@ -2411,6 +2413,7 @@ +&created_at-ResponseParameter; @@ -2535,10 +2538,12 @@ - - +&created_at-ResponseParameter; + + The volume links.