diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 568fa3859..18056c8bb 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -189,6 +189,26 @@ +
+ Metadata definition tags + + Creates, lists, gets details for, updates, and deletes metadata + definition tags. (Since API v2.0.) + + + + + + + + + + + + + + +
Metadata definition schemas @@ -221,6 +241,14 @@ + + + + + + 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 be0941bdd..f7bcaf683 100644 --- a/api-ref/src/wadls/image-api/src/v2/common.ent +++ b/api-ref/src/wadls/image-api/src/v2/common.ent @@ -887,4 +887,40 @@ empty schema (anything goes). +'> + + + A list of tag dictionary objects. + +'> + + + Name of the tag. + +'> + + + Sort key. Use attributes like name + for sorting. Default is created_at. + + + + + + Sort direction. Valid values are asc + (ascending) and desc (descending). Default is + desc. + + '> \ No newline at end of file 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/os-metadef-schemas-v2.wadl index 864521a7f..f1415ba29 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl @@ -59,6 +59,14 @@ path="properties"> + + + + + + @@ -78,12 +86,15 @@ - Gets a json-schema document that - represents a metadata definition namespace entity. (Since API v2.1.) - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition namespace schema"> + + Gets a JSON schema document that represents a metadata + definition namespace entity. (Since API v2.1.) + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -98,14 +109,18 @@ - Gets a json-schema document that - represents a metadata definition namespace(s) entity. (Since API v2.1.) - A namespaces entity is a container of namespace - entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition namespaces schema"> + + Gets a JSON schema document that represents a metadata + definition namespaces entity. (Since API v2.1.) + + + A namespaces entity is a container for namespace entities. + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -120,12 +135,15 @@ - Gets a json-schema document that - represents a metadata definition object entity. (Since API v2.1.) - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition object schema"> + + Gets a JSON schema document that represents a metadata + definition object entity. (Since API v2.1.) + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -140,14 +158,18 @@ - Gets a json-schema document that - represents a metadata definition object(s) entity. (Since API v2.1.) - An objects entity is a container of object - entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition objects schema"> + + Gets a JSON schema document that represents a metadata + definition objects entity. (Since API v2.1.) + + + An objects entity is a container for object entities. + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -162,12 +184,15 @@ - Gets a json-schema document that - represents a metadata definition property entity. (Since API v2.1.) - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition property schema"> + + Gets a JSON schema document that represents a metadata + definition property entity. (Since API v2.1.) + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -182,14 +207,18 @@ - Gets a json-schema document that - represents a metadata definition properties entity. (Since API v2.1.) - An properties entity is a container of property - entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + title="Get metadata definition properties schema"> + + Gets a JSON schema document that represents a metadata + definition properties entity. (Since API v2.1.) + + + A properties entity is a container for property entities. + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + @@ -202,17 +231,67 @@ + + + + Gets a JSON schema document that represents a metadata + definition tag entity. (Since API v2.1.) + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + + + + + + + + + + + + + + Gets a JSON schema document that represents a metadata + definition tags entity. (Since API v2.1.) + + + A tags entity is a container for tag entities. + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + + + + + + + + + + + title="Get metadata definition namespace resource type association schema"> - Gets a json-schema document that represents a metadata - definition namespace resource type association entity. (Since - API v2.1.) + Gets 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 + response is the actual response to the API call. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. @@ -227,17 +306,20 @@ + title="Get metadata definition namespace resource type associations schema"> - Gets a json-schema document that represents a metadata - definition namespace resource type association(s) entity. + Gets 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 of resource type association - entities. - The following schema is solely an example. Consider - only the response to the API call as - authoritative. + + A resource type associations entity is a container for + resource type association entities. + + + The following schema document is an example. The authoritative + response is the actual response to the API call. + 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/os-metadef-tag-v2.wadl new file mode 100755 index 000000000..05b1b19f5 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-tag-v2.wadl @@ -0,0 +1,246 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates one or more tag definitions in a specified namespace. + + + + + + + + &metadefNamespaceParameter; + &metadefTagsParameter; + &metadefTagNameParameter; + + + + + + + + &metadefTagsParameter; + &metadefTagNameParameter; + + + + + + Lists the tag definitions within + a namespace. + To manually paginate through the list of tags, use + the limit and marker + parameters. + To sort the results of this operation use the + sort_key and sort_dir parameters. + The API uses the natural sort order of the tag attribute + of the specified sort_key parameter. + + + + &metadefNamespaceParameter; + &limitMarkerReqParameter; + &metadefTagListSortParameters; + + + + + + + &metadefTagsParameter; + &metadefTagNameParameter; + + + + + + + Deletes all tag definitions within a namespace. + + + You cannot delete tags in a namespace with the 'protected' + attribute set to true (boolean); the response returns + the HTTP 403 status 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. + + + + + &metadefNamespaceParameter; + + + + + + + + + Adds a specified tag to the list of namespace tag definitions. + + + + + &metadefNamespaceParameter; + &metadefTagNameParameter; + + + + + + + &metadefTagNameParameter; + + + + + + Gets a definition for the specified tag. + + The response body shows a single tag entity. + + + + &metadefNamespaceParameter; + &metadefTagNameParameter; + + + + + + + &metadefTagNameParameter; + + + + + + + Renames a specified tag definition. + + + + + + + + &metadefNamespaceParameter; + &metadefTagNameParameter; + + + + + + + + &metadefTagNameParameter; + + + + + + + Deletes a specified tag definition within a namespace. + + + You cannot delete tags in a namespace with the 'protected' + attribute set to true (boolean); the response returns + the HTTP 403 status 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. + + + + + &metadefNamespaceParameter; + &metadefTagNameParameter; + + + + + + diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-add-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-add-response.json new file mode 100755 index 000000000..298e344bf --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-add-response.json @@ -0,0 +1,5 @@ +{ + "created_at": "2015-05-09T01:12:31Z", + "name": "added-sample-tag", + "updated_at": "2015-05-09T01:12:31Z" +} 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-req.json new file mode 100755 index 000000000..facd34af5 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-req.json @@ -0,0 +1,13 @@ +{ + "tags": [ + { + "name": "sample-tag1" + }, + { + "name": "sample-tag2" + }, + { + "name": "sample-tag3" + } + ] +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-response.json new file mode 100755 index 000000000..facd34af5 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-create-response.json @@ -0,0 +1,13 @@ +{ + "tags": [ + { + "name": "sample-tag1" + }, + { + "name": "sample-tag2" + }, + { + "name": "sample-tag3" + } + ] +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-details-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-details-response.json new file mode 100755 index 000000000..0fc7197e9 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-details-response.json @@ -0,0 +1,5 @@ +{ + "created_at": "2015-05-06T23:16:12Z", + "name": "sample-tag2", + "updated_at": "2015-05-06T23:16:12Z" +} 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-tag-list-response.json new file mode 100755 index 000000000..facd34af5 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-list-response.json @@ -0,0 +1,13 @@ +{ + "tags": [ + { + "name": "sample-tag1" + }, + { + "name": "sample-tag2" + }, + { + "name": "sample-tag3" + } + ] +} 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-req.json new file mode 100755 index 000000000..f2edbd4a3 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-req.json @@ -0,0 +1,3 @@ +{ + "name": "new-tag-name" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-response.json new file mode 100755 index 000000000..f2edbd4a3 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-tag-update-response.json @@ -0,0 +1,3 @@ +{ + "name": "new-tag-name" +} 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-get-response.json new file mode 100755 index 000000000..4e388d5b8 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tag-get-response.json @@ -0,0 +1,22 @@ +{ + "additionalProperties": false, + "required": [ + "name" + ], + "name": "tag", + "properties": { + "created_at": { + "type": "string", + "description": "Date and time of tag creation (READ-ONLY)", + "format": "date-time" + }, + "name": { + "type": "string" + }, + "updated_at": { + "type": "string", + "description": "Date and time of the last tag modification (READ-ONLY)", + "format": "date-time" + } + } +} 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-get-response.json new file mode 100755 index 000000000..a74fa0e58 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-tags-get-response.json @@ -0,0 +1,53 @@ +{ + "name": "tags", + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "properties": { + "next": { + "type": "string" + }, + "schema": { + "type": "string" + }, + "first": { + "type": "string" + }, + "tags": { + "items": { + "additionalProperties": false, + "required": [ + "name" + ], + "name": "tag", + "properties": { + "created_at": { + "type": "string", + "description": "Date and time of tag creation (READ-ONLY)", + "format": "date-time" + }, + "name": { + "type": "string" + }, + "updated_at": { + "type": "string", + "description": "Date and time of the last tag modification (READ-ONLY)", + "format": "date-time" + } + } + }, + "type": "array" + } + } +}