From bfefd9be367f812cc1030cef7de17ff5068d4fee Mon Sep 17 00:00:00 2001 From: Lakshmi N Sampath Date: Fri, 12 Sep 2014 14:36:06 -0700 Subject: [PATCH] Add documentation for Glance Metadata Definitions Catalog - API Change-Id: Ide07b75c846caa2a1c57060cc6c71b7859a78258 Closes-Bug: #1363615 --- api-ref/pom.xml | 2 +- api-ref/src/docbkx/ch_images-v2.xml | 122 ++ api-ref/src/wadls/common_project.ent | 4 +- api-ref/src/wadls/image-api/src/v2/common.ent | 1169 +++++++----- .../wadls/image-api/src/v2/os-image-v2.wadl | 1685 +++++++++-------- .../src/v2/os-metadef-namespace-v2.wadl | 357 ++++ .../src/v2/os-metadef-object-v2.wadl | 273 +++ .../src/v2/os-metadef-property-v2.wadl | 517 +++++ .../src/v2/os-metadef-resourcetype-v2.wadl | 205 ++ .../src/v2/os-metadef-schemas-v2.wadl | 253 +++ .../samples/metadef-namespace-create-req.json | 39 + .../metadef-namespace-create-response.json | 41 + .../metadef-namespace-details-response.json | 103 + .../metadef-namespace-list-response.json | 96 + .../samples/metadef-namespace-update-req.json | 7 + .../metadef-namespace-update-response.json | 12 + .../v2/samples/metadef-object-create-req.json | 24 + .../metadef-object-create-response.json | 28 + .../metadef-object-details-response.json | 28 + .../samples/metadef-object-list-response.json | 112 ++ .../v2/samples/metadef-object-update-req.json | 12 + .../metadef-object-update-response.json | 16 + .../samples/metadef-property-create-req.json | 15 + .../metadef-property-create-response.json | 15 + .../metadef-property-details-response.json | 15 + .../metadef-property-list-response.json | 86 + .../samples/metadef-property-update-req.json | 15 + .../metadef-property-update-response.json | 15 + ...etadef-resource-type-assoc-create-req.json | 5 + ...f-resource-type-assoc-create-response.json | 7 + ...def-resource-type-assoc-list-response.json | 17 + .../metadef-resource-type-list-response.json | 29 + .../v2/samples/schema-image-get-response.json | 98 +- ...schema-metadef-namespace-get-response.json | 212 +++ ...chema-metadef-namespaces-get-response.json | 243 +++ .../schema-metadef-object-get-response.json | 152 ++ .../schema-metadef-objects-get-response.json | 183 ++ ...chema-metadef-properties-get-response.json | 145 ++ .../schema-metadef-property-get-response.json | 115 ++ ...esource-type-association-get-response.json | 34 + ...source-type-associations-get-response.json | 65 + .../samples/schemas-image-get-response.json | 36 +- .../schemas-image-member-get-response.json | 6 +- .../schemas-image-members-get-response.json | 20 +- .../samples/schemas-images-get-response.json | 66 +- 45 files changed, 5362 insertions(+), 1337 deletions(-) create mode 100644 api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl create mode 100644 api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl create mode 100644 api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl create mode 100644 api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl create mode 100644 api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-details-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-list-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-details-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-list-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-details-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-list-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-req.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-get-response.json create mode 100644 api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-get-response.json diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 5e4342ba5..6bb387434 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -36,7 +36,7 @@ clouddocs-maven-plugin - + os-api-ref generate-html diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 2074850fe..568fa3859 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -108,4 +108,126 @@ +
+ Metadata definition resource types + + Lists resource types. Also, creates, lists, and removes resource + type associations in a specified namespace. (Since API v2.0.) + + + + + + + + + + + + + +
+
+ Metadata definition namespaces + + Creates, lists, gets details for, updates, and deletes metadata + definition namespaces. Defines namespaces that can contain + property definitions, object definitions, and resource type + associations. (Since API v2.0.) + + + + + + + + + + + + +
+
+ Metadata definition properties + + Creates, lists, gets details for, updates, and deletes metadata + definition properties. (Since API v2.0.) + + + + + + + + + + + + +
+
+ Metadata definition objects + + Creates, lists, gets details for, updates, and deletes metadata + definition objects. (Since API v2.0.) + + + + + + + + + + + + +
+
+ Metadata definition schemas + + Gets a JSON-schema document that represents a metadata definition + entity. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/api-ref/src/wadls/common_project.ent b/api-ref/src/wadls/common_project.ent index 9d34be8af..a4e2788cf 100644 --- a/api-ref/src/wadls/common_project.ent +++ b/api-ref/src/wadls/common_project.ent @@ -24,13 +24,13 @@ parameter value in a subsequent limited request. - -'> +'> GET'> PUT'> POST'> DELETE'> +PATCH'> 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 8bfa15b5a..be0941bdd 100644 --- a/api-ref/src/wadls/image-api/src/v2/common.ent +++ b/api-ref/src/wadls/image-api/src/v2/common.ent @@ -1,605 +1,890 @@ + A collection of common faults, these are pretty much expected + in every request. + --> - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - '> - - - - - - '> - +'> + + + + +'> + - - - - '> + ' + + + + +'> - - Filter parameter. Name of the image as a string. - + style="query" required="false" type="xsd:string"> + + Filter parameter. Name of the image as a string. + - - Filter parameter. Image visibility. Valid values are - public, private, and - shared. Default is public, - private, and shared images - with accepted member status. - + style="query" required="false" type="imageapi:string"> + + + Filter parameter. Image visibility. Valid values are + public, private, and shared. + Default is public, private, and + shared images with accepted member status. + + - - Filter parameter. Only show images with the specified - member status. Valid values are accepted, - pending, rejected, and - all. Default is - accepted. - + style="query" required="false" type="imageapi:string"> + + + Filter parameter. Only show images with the specified member status. + Valid values are accepted, pending, + rejected, and all. Default is + accepted. + + - - Filter parameter. Shows images shared with me and the - specified owner, where the owner is a tenant - ID. - + style="query" required="false" type="imageapi:string"> + + Filter parameter. Shows images shared with me and the + specified owner, where the owner is a tenant + ID. + + - - Filter parameter. The image status, such as queued, - saving, active, killed, deleted, and - pending_delete. - + style="query" required="false" type="xsd:int"> + + Filter parameter. The image status, such as queued, + saving, active, killed, deleted, and + pending_delete. + + - - Filter parameter. Value of the minimum size of the image - in bytes. - + style="query" required="false" type="xsd:string" default="ALL"> + + Filter parameter. Value of the minimum size of the image + in bytes. + + - - Filter parameter. Value of the maximum size of the image - in bytes. - + style="query" required="false" type="xsd:string" default="ALL"> + + Filter parameter. Value of the maximum size of the image + in bytes. + + - - Sort key. All image attributes can be used as the - sort_key, except tags and link attributes. Default is - created_at. - + style="query" required="false" type="xsd:string" default="ALL"> + + Sort key. All image attributes can be used as the + sort_key, except tags and link attributes. Default is + created_at. + + - - Sort direction. Valid values are asc - (ascending) and desc (descending). Default is - desc. - + style="query" required="false" type="xsd:string" default="ALL"> + + Sort direction. Valid values are asc + (ascending) and desc (descending). Default is + desc. + + - - Image tag. For example, - ?tag="cirros". - + style="query" required="false" type="xsd:string" default="ALL"> + + Image tag. For example, + ?tag="cirros". + + '> - - An images object. - + style="plain" required="true" type="xsd:string"> + + An images object. + '> - - An image object. - + style="plain" required="true" type="xsd:string"> + + An image object. + '> - - The image status. - + style="plain" required="true" type="xsd:string"> + + The image status. + '> - - The name of the image. - If this field has no value, its - value is None. - + style="plain" required="true" type="xsd:string"> + + The name of the image. + If this field has no value, its + value is None. + + '> - - - The container format of image. - If this field has no value, its - value is None. - - + name="container_format" style="plain" required="true" + type="xsd:string"> + + + The container format of image. + + If this field has no value, its + value is None. + + '> - - The date and time when the image was created. - + style="plain" required="true" type="xsd:datetime"> + + The date and time when the image was created. + '> - - - The disk format of the image. - If this field has no value, its - value is None. - - + style="plain" required="true" type="xsd:string"> + + + The disk format of the image. + + If this field has no value, its + value is None. + + '> - - The date and time when the image was last updated. - + style="plain" required="true" type="xsd:datetime"> + + The date and time when the image was last updated. + '> - - The minimum disk size in GB that is required to boot the image. - If this field has no value, its - value is None. - + style="plain" required="true" type="xsd:int"> + + The minimum disk size in GB that is required to boot the image. + If this field has no value, its + value is None. + + '> - - Defines whether the image can be deleted. - + style="plain" required="true" type="xsd:boolean"> + + Defines whether the image can be deleted. + '> - - The unique ID for the image. - + style="plain" required="true" type="csapi:uuid"> + + The unique ID for 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 None. - + style="plain" required="true" type="csapi:uuid"> + + The minimum amount of RAM in MB that is required to boot the image. + If this field has no value, its + value is None. + + '> - - Hash of the image data used. The Image service uses this value for - verification. - If this field has no value, its - value is None. - + style="plain" required="true" type="xsd:string"> + + Hash of the image data used. The Image service uses this value for + verification. + + If this field has no value, its + value is None. + + '> - - The ID of the owner, or tenant, of the image. - If this field has no value, its - value is None. - + style="plain" required="true" type="xsd:string"> + + The ID of the owner, or tenant, of the image. + If this field has no value, its + value is None. + + '> - - The image visibility. - + style="plain" required="true" type="xsd:boolean"> + + The image visibility. + '> - - The virtual size of the image. - If this field has no value, its - value is None. - + style="plain" required="true" type="xsd:int"> + + The virtual size of the image. + If this field has no value, its + value is None. + + '> - - Properties, if any, that are associated with the image. - + style="plain" required="true" type="xsd:dict"> + + 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 None. - - -' > + style="plain" required="true" type="xsd:int"> + + The size of the image data, in bytes. + If this field has no value, its + value is None. + + +'> - Image ID stored through the image API. - Typically a UUID. -' > + style="template" type="csapi:uuid" required="true"> + + + Image ID stored through the image API. Typically a UUID. + + +'> - - Image tags. - + name="tags" style="plain" type="xsd:dict" + required="true"> + + Image tags. + '> - - Image tag. - + style="template" type="xsd:string"> + + Image tag. + '> - - Format of the container. Valid values are ami, - ari, aki, bare, and ovf. - + name="container_format" style="plain" type="xsd:string" + required="false"> + + Format of the container. Valid values are ami, + ari, aki, bare, and ovf. + + '> - - Format of the disk. If set, valid values are ami, ari, aki, vhd, - vmdk, raw, qcow2, vdi, and iso. - + name="disk_format" style="plain" type="xsd:string" + required="false"> + + Format of the disk. If set, valid values are ami, ari, aki, vhd, + vmdk, raw, qcow2, vdi, and iso. + + '> - - Amount of disk space in GB that is required to boot the image. - + name="min_disk" style="plain" type="xsd:int" + required="false"> + + Amount of disk space in GB that is required to boot the image. + '> - - Amount of RAM in MB that is required to boot the image. - + name="min_ram" style="plain" type="xsd:int" + required="false"> + + Amount of RAM in MB that is required to boot the image. + '> - - If true, image is not deletable. - + name="protected" style="plain" type="xsd:bool" + required="false"> + + If true, image is not deletable. + '> - - Properties, if any, that are associated with the image. - + name="properties" style="plain" type="xsd:dict" + required="false"> + + Properties, if any, that are associated with the image. + '> - - Image's property. - + name="path" style="plain" type="xsd:string" + required="true"> + + Image's property. + '> - - 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="value" style="plain" type="xsd:string" + required="true"> + + 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 operation. Valid values are: - add: adds a new property or location in the - specified image. - remove: removes the specified image's - property or location. - replace: replaces the value of a specified - image's property or location. - + name="op" style="plain" type="xsd:string" + required="true"> + + The operation. Valid values are: + add: adds a new property or location in the + specified image. + + remove: removes the specified image's + property or location. + + replace: replaces the value of a specified + image's property or location. + + '> - - URL to access the image file kept in external - store. - + name="url" style="plain" type="xsd:string" + required="true"> + + URL to access the image file kept in external + store. + + '> - - The location metadata. - + name="metadata" style="plain" type="xsd:dict" + required="true"> + + The location metadata. + '> - - URL to access the image file kept in external store. - + name="location" style="header" type="xsd:string" + required="true"> + + URL to access the image file kept in external store. + '> - - URL to access the image file kept in external store. It - appears when you set the show_multiple_locations option - to True in the Image service's configuration - file. - + name="url" style="plain" type="xsd:string" + required="true"> + + URL to access the image file kept in external store. It + appears when you set the show_multiple_locations option + to True in the Image service's configuration + file. + + '> - - URL to access the image file kept in external store. It - appears when you set the show_multiple_locations option - to True in the Image service's configuration - file. - + name="direct_url" style="plain" type="xsd:string" + required="true"> + + URL to access the image file kept in external store. It + appears when you set the show_multiple_locations option + to True in the Image service's configuration + file. + + '> - - URL for schema of the virtual machine images. - + name="schema" style="plain" type="xsd:string" + required="true"> + + URL for schema of the virtual machine images. + '> - - URL for the first page of response. - + name="first" style="plain" type="xsd:string" + required="true"> + + URL for the first page of response. + '> - - URL for the virtual machine image. - + name="self" style="plain" type="xsd:string" + required="true"> + + URL for the virtual machine image. + '> - - URL for the virtual machine image file. - + name="file" style="plain" type="xsd:string" + required="true"> + + URL for the virtual machine image file. + '> - - URL for schema of the virtual machine image. - + name="schema" style="plain" type="xsd:string" + required="true"> + + URL for schema of the virtual machine image. + '> + style="template" type="xsd:string"> Image member ID. For example, the tenant - ID of the user with whom the image is being - shared. + xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN" + title="Members"> + + Image member ID. For example, the tenant ID of the user that the image + is being shared with. + + '> - - - The status of this image member. + + + Filter parameter. Namespace visibility. Valid values are + public and private. + Default is public and + private. + + - - - Date and time of image member - creation in the following format: - YYYY-MM-DDThh:zz:ssZ. + + + Filter parameter. value as comma separated list + 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. + + - - - Date and time of last modification of image - member in the following format: - YYYY-MM-DDThh:zz:ssZ. + + + Sort key. Use attributes like namespace + for sorting. Default is created_at. + + - - - An identifier for the image. - - - - The image member ID. For example, the tenant ID of the user - with whom the image is being shared. - - - - The URL for schema of the member. + + + Sort direction. Valid values are asc + (ascending) and desc (descending). Default is + desc. + + '> - -GET'> -PUT'> -POST'> -DELETE'> -PATCH'> + + + A namespaces object. + +'> + + + Unique namespace. + +' > + + + 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. Public or private. Default is private. + +'> + + + Namespace protection for deletion. True of False. Default is false. + +'> + + + Property definition(s) of the namespace. + +'> + + + Object definition(s) of the namespace. + +'> + + + Resource type(s) which are associated with this namespace. + +'> + + + Name of the resource type. + +'> + + + Specifies the prefix to use for the given resource type. + Any properties in the namespace should be prefixed with this + prefix when being applied to the specified resource type. + Must include prefix separator (e.g. a colon :). + + +'> + + + 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. + + +'> + + + The name of the property. + +'> + + + A properties object. + +'> + + + The name of the property. + +'> + + + The title of the property. + +'> + + + Property type. + +'> + + + Enumeration of property values. + +'> + + + specifies schema for the items in an array. + +'> + + + Property description. + +'> + + + 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. + +'> + + + describes extra items, if "tuple typing" + is being used. If the value of "items" is an array + ("tuple typing"), and if the instance is longer than + the list of schemas in "items", then the additional + items are described by the schema in this property. + If this value is false, then 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). + + +'> \ No newline at end of file diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl index c19f8d6f7..49f2e4dbf 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl @@ -1,5 +1,5 @@ - + @@ -8,784 +8,911 @@ - %common; - - %common_project; -]> + + %common; + + %common_project; + ]> - - - - - - - - - - - - - - - - - - - - - - - - - &tagParameter; - - - - - - - &member_idParameter; - - - - - + xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:imageapi="http://docs.openstack.org/image/api/v2" + xmlns:csapi="http://docs.openstack.org/image/api/v2"> + + + + + + + + + + + + + + + + &image_idParameter; + + + + + + + + + + &tagParameter; + + + + + + + + &member_idParameter; + + + + + - - - - - - - - - - - - - - - - - Lists information about all Image - service API versions. - - - - - - - - - - - - - Lists public virtual machine (VM) - images. (Since Image API v2.0.) - Returns a subset of the larger collection of images - and a link that you can use to get the next set of - images. You should always check for the presence of a - next link and use it as the URI in a - subsequent HTTP GET request. You should follow this - pattern until a next link is no longer - provided. The next link preserves any query parameters - that you send in your initial request. You can use the - first link to jump back to the first - page of the collection. If you prefer to paginate - through images manually, use the limit - and marker parameters. - The list operation accepts several types of query - parameters that let you filter the results of the - returned collection. - A client can provide direct comparison filters 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. - 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. - 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. - You can sort the results of this operation by using - the sort_key and sort_dir - parameters. The API uses the natural sorting of - whatever image attribute is provided as the - sort_key. - You can see a list of VM images which status is in - active, queued, or - saving. - - - - &limitMarkerReqParameter; - &imageListReqParameters; - - - - - - - &imagesParameter; &statusParameter; - &nameParameter; &tagParameter; &container_formatParameter; - &created_atParameter; &disk_formatParameter; - &updated_atParameter; &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; - - - - - - Creates a virtual machine (VM) - image. (Since Image API v2.0.) - Created with a Location header that - contains the newly-created URI for the image. Response - body represents the created 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 active through API - calls if you created the image with - Location header. - - - - - - - - - Name for the image. The - name of an image is not unique to a Image - service node. The API cannot expect users - to know the names of images owned by - others. - - - The image - ID. - - - - Image visibility. Public or private. - Default is public. - - - - - Image tags. - - - &container_formatRequestParameter; &disk_formatRequestParameter; - &min_diskRequestParameter; &min_ramRequestParameter; - &protectedRequestParameter; &propertiesRequestParameter; - - - - - - - &statusParameter; &container_formatParameter; - &min_ramParameter; &updated_atParameter; - &ownerParameter; &min_diskParameter; - &tagsParameter; &visibilityParameter; - &idParameter; &sizeParameter; &virtual_sizeParameter; - &nameParameter; &checksumParameter; - &created_atParameter; &disk_formatParameter; - &propertiesParameter; &protectedParameter; - &locationParameter; &selfParameter; - &fileParameter; &image_schemaParameter; - - - - - - - - Updates a specified image. (Since - Image API v2.0.) - Request body must conform to one of the following - media types: - - - application/openstack-images-v2.0-json-patch - - - application/openstack-images-v2.1-json-patch - (Since Image API v2.2) - - - You can also use the &PATCH; method to add or remove - image properties. - - For information about the &PATCH; method and the available - media types, see Image - API v2 HTTP PATCH media types. - - Preconditions - - When adding or replacing a new location - to the specified image, you must set the disk_format - and container_format parameters in the image. - When locations of the specified image - is replaced by replacing operation, the old location - must be set in the image on ahead. - - Synchronous Postconditions - - With correct permissions, you can see - the updated values of the image's attributes. - - With correct permissions, you can see - the image status as active through API calls - after adding a location to the image which had no - location. - - With correct permissions, you can see the image status as - queued through API calls after removing all - locations from the image. - - - Troubleshooting - - - If you cannot update locations, your request might lack - some information. Ensure that you meet the preconditions - and run the request again. If the request fails again, - review your API request. - - - - - - - - &image_idParameter; - &pathParameter; &valueParameter; &opParameter; - &urlParameter; &metadataParameter; - - - - - - - &statusParameter; - &nameParameter; &tagParameter; &container_formatParameter; - &created_atParameter; &disk_formatParameter; - &updated_atParameter; &min_diskParameter; - &protectedParameter; &idParameter; &min_ramParameter; - &checksumParameter; &ownerParameter; - &visibilityParameter; &sizeParameter; - &location_urlParameter; &metadataParameter; - &propertiesParameter; &direct_urlParameter; &selfParameter; - &fileParameter; &image_schemaParameter; - - - - - - Gets details for a specified image. - (Since Image API v2.0.) - Response body is a single image entity. - Preconditions - - The specified image must exist. - - - - - &image_idParameter; - - - - - - &statusParameter; - &nameParameter; &tagParameter; &container_formatParameter; - &created_atParameter; &disk_formatParameter; - &updated_atParameter; &min_diskParameter; - &protectedParameter; &idParameter; &min_ramParameter; - &checksumParameter; &ownerParameter; - &visibilityParameter; &sizeParameter; - &location_urlParameter; &metadataParameter; - &propertiesParameter; &direct_urlParameter; &selfParameter; - &fileParameter; &image_schemaParameter; - - - - - - Deletes a specified image. (Since - Image API v2.0.) - You cannot delete images with the 'protected' - attribute set to true (boolean). - Preconditions - - You can delete an image in all status - except deleted. - You must first set the 'protected' attribute - to false (boolean) and then perform - the delete. - - Synchronous Postconditions - - The response is empty and returns the - HTTP 204 status code. - The image is deleted in 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. - - TroubleShooting - - - The response returns the HTTP 403 status code when the - protected attribute is set to - true even if you have correct permissions. - Ensure that you meet the preconditions and run the request - again. If the request fails again, review your API request. - - - - - - &image_idParameter; - - - - - - - - Uploads binary image data. (Since - Image API v2.0.) - Set the Content-Type request header to - application/octet-stream. - 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 - Preconditions - - The specified image must exist before you - store binary image data. - You must set disk_format and container_format - in the image before you store the data. - You can only store the data into a image which - status is queued. - The user must have enough image strage quota - remaining to store the data. - Size of the data must be less than OpenStack - Image service restricts. - - Synchronous Postconditions - - With correct permissions, you can see the - image status as active through API calls. - - With correct access, you can see the stored - data in the storage system that OpenStack Image service - manages. - - Troubleshooting - - - 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. - - The storage back ends for storing the data must have - enough free storage space to match the size of the data. - - - - - - &image_idParameter; - - - - - - Downloads binary image data. (Since - Image API v2.0.) - Example call: curl -i -X GET -H "X-Auth-Token: - $token" - $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 - value application/octet-stream. The - Content-MD5 header contains an MD5 - checksum of the image data. Clients are encouraged to - verify the integrity of the image data they receive by - using this checksum. - - Preconditions - - The specified images must exist. - - Synchronous Postconditions - - You can download the binary image data - in your machine if the specified image has image - data. - If image data exists, you receive the - HTTP 200 status code. - If no image data exists, you receive - the HTTP 204 status code. - - - - &image_idParameter; - - - - - - - Adds a specified tag to a specified - image. (Since Image API v2.0.) - - - &image_idParameter; &tagParameter; - - - - - - Deletes a specified tag from a - specified image. (Since Image API v2.0.) - - - - &image_idParameter; &tagParameter; - - - - - - - Shows image member details. - Response body is a single image member entity. - (Since Image API 2.2.) - Preconditions - - The specified image must exist. - - You must be the owner or a member of - the specified image. - - - - - &image_idParameter; - - - - - - &memberListParameter; - - - - - - Lists the tenants with whom this - image has been shared. (Since Image API v2.1.) - If a user with whom this image is shared 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. - Preconditions - - The specified image must exist. - - You must be the owner or a member of - the specified image. - - - - &image_idParameter; - - - - - - &memberListParameter; - - - The URL for schema of the - members. - - - - - - - - Adds a specified tenant ID as an - image member. (Since Image API v2.1.) - Preconditions - - The specified images must exist. - - You can only add a new member to an - image which 'visibility' attribute is private. - - You must be the owner of the specified - image. - - Synchronous Postconditions - - With correct permissions, you can see - the member status of the image as pending - through API calls. - - Troubleshooting - - - Even if you have correct permissions, if the - visibility attribute is set to public, the request - returns the HTTP 403 error code. Ensure that you meet the preconditions - and run the request again. If the request fails again, - review your API request. - - - If the specified member is already a member for the image, - the service returns the HTTP 409 Conflict error code. In - case you meant a different member, double-check that you - specified the correct member. - - - - - - - - &image_idParameter; - &member_idParameter; - - - - - - &memberListParameter; - - - - - - - - - - - - - - Sets the specified status for the - specified member of the specified image. (Since Image - API v2.1.) - Preconditions - - The specified images must exist. - - You must be a member of the - specified image. - - Synchronous Postconditions - - 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. - - - - - - - &image_idParameter; - - - The status of this image - member. - - - - - - - - &memberListParameter; - - - - - - Deletes a specified tenant ID from - the member list of the specified image. (Since Image - API v2.1.) - Preconditions - - The specified image must exist. - - You must be the owner of the specified - image. - - Synchronous Postconditions - - The specified member is removed from - the image members. - - Troubleshooting - - - Even if you have correct permissions, if you are not the - owner of the specified image, the request returns the HTTP - 403 error code. Ensure that you meet the preconditions - and run the request again. If the request fails again, - review your API request. - - - - - - &image_idParameter; - - - - - - - + + + + + + + + + + + + + + + + + + Lists information about all Image + service API versions. + + + + + + + + + + + + + + Lists public virtual machine (VM) + images. (Since Image API v2.0.) + + Returns a subset of the larger collection of images + and a link that you can use to get the next set of + images. You should always check for the presence of a + next link and use it as the URI in a + subsequent HTTP GET request. You should follow this + pattern until a next link is no longer + provided. The next link preserves any query parameters + that you send in your initial request. You can use the + first link to jump back to the first + page of the collection. If you prefer to paginate + through images manually, use the limit + and marker parameters. + + The list operation accepts several types of query + parameters that let you filter the results of the + returned collection. + + A client can provide direct comparison filters 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. + + 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. + + 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. + + You can sort the results of this operation by using + the sort_key and sort_dir + parameters. The API uses the natural sorting of + whatever image attribute is provided as the + sort_key. + + You can see a list of VM images which status is in + active, queued, or + saving. + + + + + &limitMarkerReqParameter; + &imageListReqParameters; + + + + + + + + &imagesParameter; &statusParameter; + &nameParameter; &tagParameter; &container_formatParameter; + &created_atParameter; &disk_formatParameter; + &updated_atParameter; &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; + + + + + + Creates a virtual machine (VM) + image. (Since Image API v2.0.) + + Created with a Location header that + contains the newly-created URI for the image. Response + body represents the created 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 active through API + calls if you created the image with + Location header. + + + + + + + + + + + + Name for the image. The + name of an image is not unique to a Image + service node. The API cannot expect users + to know the names of images owned by + others. + + + + + + The image + ID. + + + + + + Image visibility. Public or private. + Default is public. + + + + + + Image tags. + + + &container_formatRequestParameter; &disk_formatRequestParameter; + &min_diskRequestParameter; &min_ramRequestParameter; + &protectedRequestParameter; &propertiesRequestParameter; + + + + + + + + &statusParameter; &container_formatParameter; + &min_ramParameter; &updated_atParameter; + &ownerParameter; &min_diskParameter; + &tagsParameter; &visibilityParameter; + &idParameter; &sizeParameter; &virtual_sizeParameter; + &nameParameter; &checksumParameter; + &created_atParameter; &disk_formatParameter; + &propertiesParameter; &protectedParameter; + &locationParameter; &selfParameter; + &fileParameter; &image_schemaParameter; + + + + + + + Updates a specified image. (Since + Image API v2.0.) + + Request body must conform to one of the following + media types: + + + + application/openstack-images-v2.0-json-patch + + + application/openstack-images-v2.1-json-patch + (Since Image API v2.2) + + + + You can also use the &PATCH; method to add or remove + image properties. + + + For information about the &PATCH; method and the available + media types, see + + Image + API v2 HTTP PATCH media types. + + Preconditions + + + When adding or replacing a new location + to the specified image, you must set the disk_format + and container_format parameters in the image. + + + + When locations of the specified image + is replaced by replacing operation, the old location + must be set in the image on ahead. + + + + Synchronous Postconditions + + + With correct permissions, you can see + the updated values of the image's attributes. + + + + With correct permissions, you can see + the image status as active through API calls + after adding a location to the image which had no + location. + + + + + With correct permissions, you can see the image status as + queued through API calls after removing all + locations from the image. + + + + Troubleshooting + + + + If you cannot update locations, your request might lack + some information. Ensure that you meet the preconditions + and run the request again. If the request fails again, + review your API request. + + + + + + + + + + &image_idParameter; + &pathParameter; &valueParameter; &opParameter; + &urlParameter; &metadataParameter; + + + + + + + + &statusParameter; + &nameParameter; &tagParameter; &container_formatParameter; + &created_atParameter; &disk_formatParameter; + &updated_atParameter; &min_diskParameter; + &protectedParameter; &idParameter; &min_ramParameter; + &checksumParameter; &ownerParameter; + &visibilityParameter; &sizeParameter; + &location_urlParameter; &metadataParameter; + &propertiesParameter; &direct_urlParameter; &selfParameter; + &fileParameter; &image_schemaParameter; + + + + + + Gets details for a specified image. + (Since Image API v2.0.) + + Response body is a single image entity. + Preconditions + + + The specified image must exist. + + + + + + + + + &statusParameter; + &nameParameter; &tagParameter; &container_formatParameter; + &created_atParameter; &disk_formatParameter; + &updated_atParameter; &min_diskParameter; + &protectedParameter; &idParameter; &min_ramParameter; + &checksumParameter; &ownerParameter; + &visibilityParameter; &sizeParameter; + &location_urlParameter; &metadataParameter; + &propertiesParameter; &direct_urlParameter; &selfParameter; + &fileParameter; &image_schemaParameter; + + + + + + Deletes a specified image. (Since + Image API v2.0.) + + You cannot delete images with the 'protected' + attribute set to true (boolean). + + Preconditions + + + You can delete an image in all status + except deleted. + + + + You must first set the 'protected' attribute + to false (boolean) and then perform + the delete. + + + + Synchronous Postconditions + + + The response is empty and returns the + HTTP 204 status code. + + + + The image is deleted in 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. + + + + TroubleShooting + + + + The response returns the HTTP 403 status code when the + protected attribute is set to + true even if you have correct permissions. + Ensure that you meet the preconditions and run the request + again. If the request fails again, review your API request. + + + + + + + + + + + Uploads binary image data. (Since + Image API v2.0.) + + Set the Content-Type request header to + application/octet-stream. + + 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 + + Preconditions + + + The specified image must exist before you + store binary image data. + + + + You must set disk_format and container_format + in the image before you store the data. + + + + You can only store the data into a image which + status is queued. + + + + The user must have enough image strage quota + remaining to store the data. + + + + Size of the data must be less than OpenStack + Image service restricts. + + + + Synchronous Postconditions + + + With correct permissions, you can see the + image status as active through API calls. + + + + With correct access, you can see the stored + data in the storage system that OpenStack Image service + manages. + + + + Troubleshooting + + + + 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. + + + + The storage back ends for storing the data must have + enough free storage space to match the size of the data. + + + + + + + + + Downloads binary image data. (Since + Image API v2.0.) + + Example call: curl -i -X GET -H "X-Auth-Token: + $token" + $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 + value application/octet-stream. The + Content-MD5 header contains an MD5 + checksum of the image data. Clients are encouraged to + verify the integrity of the image data they receive by + using this checksum. + + + Preconditions + + + The specified images must exist. + + + Synchronous Postconditions + + + You can download the binary image data + in your machine if the specified image has image + data. + + + + If image data exists, you receive the + HTTP 200 status code. + + + + If no image data exists, you receive + the HTTP 204 status code. + + + + + + + + + + + Adds a specified tag to a specified image. (Since Image API v2.0.) + + + + + + + + Deletes a specified tag from a specified image. (Since Image API + v2.0.) + + + + + + + + Shows image member details. + Response body is a single image member entity. + (Since Image API 2.2.) + + Preconditions + + + The specified image must exist. + + + + You must be the owner or a member of + the specified image. + + + + + + + + + + + + + + + + Lists the tenants with whom this + image has been shared. (Since Image API v2.1.) + + If a user with whom this image is shared 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. + + Preconditions + + + The specified image must exist. + + + + You must be the owner or a member of + the specified image. + + + + + + + + + + + + + The URL for schema of the + members. + + + + + + + + + + Adds a specified tenant ID as an + image member. (Since Image API v2.1.) + + Preconditions + + + The specified images must exist. + + + + You can only add a new member to an + image which 'visibility' attribute is private. + + + + You must be the owner of the specified + image. + + + + Synchronous Postconditions + + + With correct permissions, you can see + the member status of the image as pending + through API calls. + + + + Troubleshooting + + + + Even if you have correct permissions, if the + visibility attribute is set to public, the request + returns the HTTP 403 error code. Ensure that you meet the preconditions + and run the request again. If the request fails again, + review your API request. + + + + + If the specified member is already a member for the image, + the service returns the HTTP 409 Conflict error code. In + case you meant a different member, double-check that you + specified the correct member. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets the specified status for the + specified member of the specified image. (Since Image + API v2.1.) + + Preconditions + + + The specified images must exist. + + + + You must be a member of the + specified image. + + + + Synchronous Postconditions + + + 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. + + + + + + + + + + + + The status of this image + member. + + + + + + + + + + + + + + + + + Deletes a specified tenant ID from + the member list of the specified image. (Since Image + API v2.1.) + + Preconditions + + + The specified image must exist. + + + + You must be the owner of the specified + image. + + + + Synchronous Postconditions + + + The specified member is removed from + the image members. + + + + Troubleshooting + + + + Even if you have correct permissions, if you are not the + owner of the specified image, the request returns the HTTP + 403 error code. Ensure that you meet the preconditions + and run the request again. If the request fails again, + review your API request. + + + + + + + + + + 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/os-metadef-namespace-v2.wadl new file mode 100644 index 000000000..ac4ac9202 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl @@ -0,0 +1,357 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + + + + + + Unique namespace. + + + + + + + + + + + + + + + + + + + Creates a namespace. + + + The namespace is created with a Location header + that contains the newly-created URI for the namespace. + + + + + + + + + + + A namespace name that is unique across all users. + + + + + + + User-friendly name that can be used in 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. + + + + + + + + + + + &metadefNamespaceParameter; &metadefNSDisplayNameParameter; + &metadefNSDescParameter; &metadefNSVisibilityParameter; + &metadefNSProtectedParameter; &metadefPropertiesParameter; + &metadefObjectsParameter; &metadefResTypeAssocsParameter; + + + + + + Lists public namespaces. + + Returns a subset in the larger collection of namespaces and a + link that you can use to get the next set of namespaces. Check + for the presence of a next link and use it as the + URI in a subsequent HTTP GET request. Follow this pattern + until a next link is no longer provided. The + next link preserves any query parameters that you + send in your initial request. You can use the + first link to return to the first page in the + collection. If you prefer to paginate through namespaces + manually, use the limit and marker + parameters. + + + The list operation accepts the resource_types and + visibility query parameters, which let you filter + the results in the returned collection. + + + To sort the results of this operation, use the + sort_key and sort_dir parameters. + The API uses the natural sorting order in the namespace + attribute that you provide as the sort_key + parameter. + + + + + &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 the specified 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. + + + + + + + + + + + &namespacesParameter; &metadefNamespaceParameter; + &metadefNSDisplayNameParameter; &metadefNSDescParameter; + &metadefNSVisibilityParameter; &metadefNSProtectedParameter; + &metadefResTypeAssocsParameter; + + + + + + + Gets details for a specified namespace. + + + The response body shows a single namespace entity with all + details including properties and objects. + + + + + + + + + + + + + Updates a specified namespace. + + + + + + + &metadefNamespace_idParameter; + + + + + + + + + + + + + + Deletes a specified 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. + + + To delete a namespace, you must first make an update namespace + request to set the protected attribute to false + (boolean) on the namespace. Then, delete the namespace. + + + If the operation succeeds, the response returns the HTTP 204 + status 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. + + + + + + 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/os-metadef-object-v2.wadl new file mode 100644 index 000000000..9e9d5c9ac --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl @@ -0,0 +1,273 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates an object definition in a specified + namespace. + + + + + + + + + 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 + + + + + + + + + &metadefNamespaceParameter; &metadefNSDisplayNameParameter; + &metadefNSDescParameter; &metadefNSVisibilityParameter; + &metadefNSProtectedParameter; &metadefPropertiesParameter; + &metadefObjectsParameter; &metadefResTypeAssocsParameter; + + + + + + Lists object definitions within + 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 should always check for the presence of a + next link and use it as the URI in a + subsequent HTTP GET request. You should follow this + pattern until a next link is no longer + provided. The next link preserves any query parameters + that you send in your initial request. You can use the + first link to jump back to the first + page of the collection. If you prefer to paginate + through namespaces manually, use the limit + and marker parameters. + The list operation accepts resource_types and + visibility as query parameters that let you + filter the results of the returned collection. + 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. + You can sort the results of this operation by using + the sort_key and sort_dir + parameters. The API uses the natural sorting of + whatever namespace attribute is provided as the + sort_key. + + + + &metadefNamespaceListReqParameters; + + + + + + &namespacesParameter; &metadefNamespaceParameter; + &metadefNSDisplayNameParameter; &metadefNSDescParameter; + &metadefNSVisibilityParameter; &metadefNSProtectedParameter; + &metadefResTypeAssocsParameter; + + + + + Gets definition for a specified object. + + Response body is a single object entity. + + + + &metadefNamespace_idParameter; + + + + + + + + + + + + + Updates a specified object definition. + + + + + + + &metadefNamespace_idParameter; + + + + + + + + + + + + + Deletes a specified object definition within 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. + + + 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. + + + + + &metadefNamespace_idParameter; + + + + + 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/os-metadef-property-v2.wadl new file mode 100644 index 000000000..c50d6fdb7 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl @@ -0,0 +1,517 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a property definition within a + namespace. Schema is subset of JSON Property definition schema + + + + + + + + + Name of the property. + + + + Property title. + + + + Property type + + + + + Enumeration of property values. + + + + + specifies schema for the items in an + array. + + + + + Property description. + + + + + 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 + schemas 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 listed in + items. + + + A value of true indicates an empty schema, or + anything goes. + + + + + + + + + + &metadefPropertyNameParameter; + &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; + &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; + &metadefPropertyDescParameter; &metadefPropertyMinParameter; + &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; + &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; + &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; + &metadefPropertyUniqueItemsParameter; + &metadefPropertyAdditionalItemsParameter; + + + + + + Lists property definitions within + a namespace. + Returns a list of property definitions in a + namespace. + + + + &metadefNamespace_idParameter; + + + + + + &metadefPropertyListParameter; + &metadefPropertyNameParameter; + &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; + &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; + &metadefPropertyDescParameter; &metadefPropertyMinParameter; + &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; + &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; + &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; + &metadefPropertyUniqueItemsParameter; + &metadefPropertyAdditionalItemsParameter; + + + + + + Gets definition for a specified property. + + Response body is a single property entity. + + + + &metadefNamespace_idParameter; + &metadefPropertyNameIdParameter; + + + + + + + + &metadefPropertyNameParameter; + &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; + &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; + &metadefPropertyDescParameter; &metadefPropertyMinParameter; + &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; + &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; + &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; + &metadefPropertyUniqueItemsParameter; + &metadefPropertyAdditionalItemsParameter; + + + + + + Updates a specified property definition. + + + + + + + + + Name of the property. + + + + Property title. + + + + Property type + + + + + Enumeration of property values. + + + + + specifies schema for the items in an + array. + + + + + Property description. + + + + + 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 + schemas 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 listed in + items. + + + A value of true indicates an empty schema, or + anything goes. + + + + + + + + + + + &metadefPropertyNameParameter; + &metadefPropertyTitleParameter; &metadefPropertyTypeParameter; + &metadefPropertyEnumParameter; &metadefPropertyItemsParameter; + &metadefPropertyDescParameter; &metadefPropertyMinParameter; + &metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; + &metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; + &metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; + &metadefPropertyUniqueItemsParameter; + &metadefPropertyAdditionalItemsParameter; + + + + + + + Removes a specified property definition in a specified + namespace. + + + To remove a property, first make an update namespace request + to set the protected attribute to false (boolean) + on the namespace. Then, remove the property. If the operation + succeeds, the response returns the HTTP 204 status code. + + + If you try to remove a property in a namespace + with the protected attribute set to true + (boolean), the operation fails and the response returns the + HTTP 403 error code. + + + + + &metadefNamespace_idParameter; + &metadefPropertyNameIdParameter; + + + + + 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/os-metadef-resourcetype-v2.wadl new file mode 100644 index 000000000..8f8beb897 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl @@ -0,0 +1,205 @@ + + + + + + + + + + + %common; + + %common_project; +]> + + + + + + + + + + + + + + + + + + + Unique namespace. + + + + + + + + + Name of the resource type. + + + + + + + + + + + + + + + + + Creates a resource type association + in a namespace. + + + + + + + + + Name of the resource type. + + + + + + Prefix for the specified 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 specified resource type. + + + + + + + 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. + + + + + + + + + + + + + + + + Lists resource types. + + Lists all possible resource types. You can assign metadata + definition namespaces to these resource types. See the + metadata definition resource types section. + + + + + + + + + + + + + + Lists resource type associations in a specified namespace. + + + The response body lists resource type association entities. + + + + + + + + + + + + + + Removes a specified resource type association in a specified + namespace. + + + To remove an association, first make an update namespace + request to set the protected attribute to false + (boolean) on the namespace. Then, remove the association. If + the operation succeeds, the response returns the HTTP 204 + status code. + + + If you try to remove resource type associations in a namespace + with the protected attribute set to true + (boolean), the operation fails and the response returns the + HTTP 403 error code. + + + + + + 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 new file mode 100644 index 000000000..864521a7f --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl @@ -0,0 +1,253 @@ + + + + + + + + + + + + +%common;]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 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. + + + + + + + + + + + + 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. + + + + + + + + + + + + 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. + + + + + + + + + + + + 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. + + + + + + + + + + + + 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. + + + + + + + + + + + + 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. + + + + + + + + + + + + + Gets a json-schema document that represents a metadata + definition namespace resource type association entity. (Since + API v2.1.) + + The following schema is solely an example. Consider + only the response to the API call as + authoritative. + + + + + + + + + + + + + Gets a json-schema document that represents a metadata + definition namespace resource type association(s) 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. + + + + + + + + + + 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-req.json new file mode 100644 index 000000000..3c2729292 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-req.json @@ -0,0 +1,39 @@ +{ + "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the hardware specification required when a new vm is requested.", + "display_name": "Hypervisor Selection", + "namespace": "OS::Compute::Hypervisor", + "properties": { + "hypervisor_type": { + "description": "The hypervisor type.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "title": "Hypervisor Type", + "type": "string" + }, + "vm_mode": { + "description": "The virtual machine mode.", + "enum": [ + "hvm", + "xen", + "uml", + "exe" + ], + "title": "VM Mode", + "type": "string" + } + }, + "protected": true, + "resource_type_associations": [ + { + "name": "OS::Glance::Image" + } + ], + "visibility": "public" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-response.json new file mode 100644 index 000000000..24384535a --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-response.json @@ -0,0 +1,41 @@ +{ + "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the hardware specification required when a new vm is requested.", + "display_name": "Hypervisor Selection", + "namespace": "OS::Compute::Hypervisor", + "properties": { + "hypervisor_type": { + "description": "The hypervisor type.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "title": "Hypervisor Type", + "type": "string" + }, + "vm_mode": { + "description": "The virtual machine mode.", + "enum": [ + "hvm", + "xen", + "uml", + "exe" + ], + "title": "VM Mode", + "type": "string" + } + }, + "protected": true, + "resource_type_associations": [ + { + "name": "OS::Glance::Image" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Hypervisor", + "visibility": "public" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-details-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-details-response.json new file mode 100644 index 000000000..9e42b9d76 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-details-response.json @@ -0,0 +1,103 @@ +{ + "created_at": "2014-08-28T17:13:06Z", + "description": "The libvirt compute driver options. These are properties specific to compute drivers. For a list of all hypervisors, see here: https://wiki.openstack.org/wiki/HypervisorSupportMatrix.", + "display_name": "libvirt Driver Options", + "namespace": "OS::Compute::Libvirt", + "owner": "admin", + "properties": { + "hw_disk_bus": { + "description": "Specifies the type of disk controller to attach disk devices to.", + "enum": [ + "scsi", + "virtio", + "uml", + "xen", + "ide", + "usb" + ], + "title": "Disk Bus", + "type": "string" + }, + "hw_machine_type": { + "description": "Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).", + "title": "Machine Type", + "type": "string" + }, + "hw_qemu_guest_agent": { + "description": "It is a daemon program running inside the domain which is supposed to help management applications with executing functions which need assistance of the guest OS. For example, freezing and thawing filesystems, entering suspend. However, guest agent (GA) is not bullet proof, and hostile guest OS can send spurious replies.", + "enum": [ + "yes", + "no" + ], + "title": "QEMU Guest Agent", + "type": "string" + }, + "hw_rng_model": { + "default": "virtio", + "description": "Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default: The generator device is disabled. /dev/random is used as the default entropy source. To specify a physical HW RNG device, use the following option in the nova.conf file: rng_dev_path=/dev/hwrng", + "title": "Random Number Generator Device", + "type": "string" + }, + "hw_scsi_model": { + "default": "virtio-scsi", + "description": "Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI controller device that provides improved scalability and performance, and supports advanced SCSI hardware.", + "title": "SCSI Model", + "type": "string" + }, + "hw_video_model": { + "description": "The video image driver used.", + "enum": [ + "vga", + "cirrus", + "vmvga", + "xen", + "qxl" + ], + "title": "Video Model", + "type": "string" + }, + "hw_video_ram": { + "description": "Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram.", + "title": "Max Video Ram", + "type": "integer" + }, + "hw_vif_model": { + "description": "Specifies the model of virtual network interface device to use. The valid options depend on the configured hypervisor. KVM and QEMU: e1000, ne2k_pci, pcnet, rtl8139, and virtio. VMware: e1000, e1000e, VirtualE1000, VirtualE1000e, VirtualPCNet32, VirtualSriovEthernetCard, and VirtualVmxnet. Xen: e1000, netfront, ne2k_pci, pcnet, and rtl8139.", + "enum": [ + "e1000", + "ne2k_pci", + "pcnet", + "rtl8139", + "virtio", + "e1000", + "e1000e", + "VirtualE1000", + "VirtualE1000e", + "VirtualPCNet32", + "VirtualSriovEthernetCard", + "VirtualVmxnet", + "netfront", + "ne2k_pci" + ], + "title": "Virtual Network Interface", + "type": "string" + }, + "os_command_line": { + "description": "The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).", + "title": "Kernel Command Line", + "type": "string" + } + }, + "protected": true, + "resource_type_associations": [ + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Glance::Image", + "updated_at": "2014-08-28T17:13:06Z" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Libvirt", + "updated_at": "2014-08-28T17:13:06Z", + "visibility": "public" +} 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-namespace-list-response.json new file mode 100644 index 000000000..a146c9565 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-list-response.json @@ -0,0 +1,96 @@ +{ + "first": "/v2/metadefs/namespaces?sort_key=created_at&sort_dir=asc", + "namespaces": [ + { + "created_at": "2014-08-28T17:13:06Z", + "description": "The libvirt compute driver options. These are properties specific to compute drivers. For a list of all hypervisors, see here: https://wiki.openstack.org/wiki/HypervisorSupportMatrix.", + "display_name": "libvirt Driver Options", + "namespace": "OS::Compute::Libvirt", + "owner": "admin", + "protected": true, + "resource_type_associations": [ + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Glance::Image", + "updated_at": "2014-08-28T17:13:06Z" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Libvirt", + "updated_at": "2014-08-28T17:13:06Z", + "visibility": "public" + }, + { + "created_at": "2014-08-28T17:13:06Z", + "description": "Compute drivers may enable quotas on CPUs available to a VM, disk tuning, bandwidth I/O, and instance VIF traffic control. See: http://docs.openstack.org/admin-guide-cloud/content/customize-flavors.html", + "display_name": "Flavor Quota", + "namespace": "OS::Compute::Quota", + "owner": "admin", + "protected": true, + "resource_type_associations": [ + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Nova::Flavor", + "updated_at": "2014-08-28T17:13:06Z" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota", + "updated_at": "2014-08-28T17:13:06Z", + "visibility": "public" + }, + { + "created_at": "2014-08-28T17:13:06Z", + "description": "Trusted compute pools with Intel\u00ae Trusted Execution Technology (Intel\u00ae TXT) support IT compliance by protecting virtualized data centers - private, public, and hybrid clouds against attacks toward hypervisor and BIOS, firmware, and other pre-launch software components.", + "display_name": "Trusted Compute Pools (Intel\u00ae TXT)", + "namespace": "OS::Compute::Trust", + "owner": "admin", + "protected": true, + "resource_type_associations": [ + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Nova::Flavor", + "updated_at": "2014-08-28T17:13:06Z" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Trust", + "updated_at": "2014-08-28T17:13:06Z", + "visibility": "public" + }, + { + "created_at": "2014-08-28T17:13:06Z", + "description": "This provides the preferred socket/core/thread counts for the virtual CPU instance exposed to guests. This enables the ability to avoid hitting limitations on vCPU topologies that OS vendors place on their products. See also: http://git.openstack.org/cgit/openstack/nova-specs/tree/specs/juno/virt-driver-vcpu-topology.rst", + "display_name": "Virtual CPU Topology", + "namespace": "OS::Compute::VirtCPUTopology", + "owner": "admin", + "protected": true, + "resource_type_associations": [ + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Glance::Image", + "prefix": "hw_", + "updated_at": "2014-08-28T17:13:06Z" + }, + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Cinder::Volume", + "prefix": "hw_", + "properties_target": "image", + "updated_at": "2014-08-28T17:13:06Z" + }, + { + "created_at": "2014-08-28T17:13:06Z", + "name": "OS::Nova::Flavor", + "prefix": "hw:", + "updated_at": "2014-08-28T17:13:06Z" + } + ], + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::VirtCPUTopology", + "updated_at": "2014-08-28T17:13:06Z", + "visibility": "public" + } + ], + "schema": "/v2/schemas/metadefs/namespaces" +} 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-req.json new file mode 100644 index 000000000..d06a41c4d --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-req.json @@ -0,0 +1,7 @@ +{ + "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the hardware specification required when a new vm is requested.", + "display_name": "Hypervisor Selection", + "namespace": "OS::Compute::Hypervisor", + "protected": false, + "visibility": "public" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-response.json new file mode 100644 index 000000000..d504c0c76 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-response.json @@ -0,0 +1,12 @@ +{ + "created_at": "2014-09-19T13:31:37Z", + "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the harware specification required when a new vm is requested.", + "display_name": "Hypervisor Selection", + "namespace": "OS::Compute::Hypervisor", + "owner": "7ec22942411e427692e8a3436be1031a", + "protected": false, + "schema": "/v2/schemas/metadefs/namespace", + "self": "/v2/metadefs/namespaces/OS::Compute::Hypervisor", + "updated_at": "2014-09-19T13:31:37Z", + "visibility": "public" +} 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-req.json new file mode 100644 index 000000000..2aefab80c --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-req.json @@ -0,0 +1,24 @@ +{ + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_period": { + "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.", + "maximum": 1000000, + "minimum": 1000, + "title": "Quota: CPU Period", + "type": "integer" + }, + "quota:cpu_quota": { + "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.", + "title": "Quota: CPU Quota", + "type": "integer" + }, + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [] +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-response.json new file mode 100644 index 000000000..d0184bd9a --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-response.json @@ -0,0 +1,28 @@ +{ + "created_at": "2014-09-19T18:20:56Z", + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_period": { + "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.", + "maximum": 1000000, + "minimum": 1000, + "title": "Quota: CPU Period", + "type": "integer" + }, + "quota:cpu_quota": { + "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.", + "title": "Quota: CPU Quota", + "type": "integer" + }, + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits", + "updated_at": "2014-09-19T18:20:56Z" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-details-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-details-response.json new file mode 100644 index 000000000..d0184bd9a --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-details-response.json @@ -0,0 +1,28 @@ +{ + "created_at": "2014-09-19T18:20:56Z", + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_period": { + "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.", + "maximum": 1000000, + "minimum": 1000, + "title": "Quota: CPU Period", + "type": "integer" + }, + "quota:cpu_quota": { + "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.", + "title": "Quota: CPU Quota", + "type": "integer" + }, + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits", + "updated_at": "2014-09-19T18:20:56Z" +} 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-object-list-response.json new file mode 100644 index 000000000..067460225 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-list-response.json @@ -0,0 +1,112 @@ +{ + "objects": [ + { + "created_at": "2014-09-18T18:16:35Z", + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_period": { + "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.", + "maximum": 1000000, + "minimum": 1000, + "title": "Quota: CPU Period", + "type": "integer" + }, + "quota:cpu_quota": { + "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.", + "title": "Quota: CPU Quota", + "type": "integer" + }, + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits" + }, + { + "created_at": "2014-09-18T18:16:35Z", + "description": "Using disk I/O quotas, you can set maximum disk write to 10 MB per second for a VM user.", + "name": "Disk QoS", + "properties": { + "quota:disk_read_bytes_sec": { + "description": "Sets disk I/O quota for disk read bytes / sec.", + "title": "Quota: Disk read bytes / sec", + "type": "integer" + }, + "quota:disk_read_iops_sec": { + "description": "Sets disk I/O quota for disk read IOPS / sec.", + "title": "Quota: Disk read IOPS / sec", + "type": "integer" + }, + "quota:disk_total_bytes_sec": { + "description": "Sets disk I/O quota for total disk bytes / sec.", + "title": "Quota: Disk Total Bytes / sec", + "type": "integer" + }, + "quota:disk_total_iops_sec": { + "description": "Sets disk I/O quota for disk total IOPS / sec.", + "title": "Quota: Disk Total IOPS / sec", + "type": "integer" + }, + "quota:disk_write_bytes_sec": { + "description": "Sets disk I/O quota for disk write bytes / sec.", + "title": "Quota: Disk Write Bytes / sec", + "type": "integer" + }, + "quota:disk_write_iops_sec": { + "description": "Sets disk I/O quota for disk write IOPS / sec.", + "title": "Quota: Disk Write IOPS / sec", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/Disk QoS" + }, + { + "created_at": "2014-09-18T18:16:35Z", + "description": "Bandwidth QoS tuning for instance virtual interfaces (VIFs) may be specified with these properties. Incoming and outgoing traffic can be shaped independently. If not specified, no quality of service (QoS) is applied on that traffic direction. So, if you want to shape only the network's incoming traffic, use inbound only (and vice versa). The OpenStack Networking service abstracts the physical implementation of the network, allowing plugins to configure and manage physical resources. Virtual Interfaces (VIF) in the logical model are analogous to physical network interface cards (NICs). VIFs are typically owned a managed by an external service; for instance when OpenStack Networking is used for building OpenStack networks, VIFs would be created, owned, and managed in Nova. VIFs are connected to OpenStack Networking networks via ports. A port is analogous to a port on a network switch, and it has an administrative state. When a VIF is attached to a port the OpenStack Networking API creates an attachment object, which specifies the fact that a VIF with a given identifier is plugged into the port.", + "name": "Virtual Interface QoS", + "properties": { + "quota:vif_inbound_average": { + "description": "Network Virtual Interface (VIF) inbound average in kilobytes per second. Specifies average bit rate on the interface being shaped.", + "title": "Quota: VIF Inbound Average", + "type": "integer" + }, + "quota:vif_inbound_burst": { + "description": "Network Virtual Interface (VIF) inbound burst in total kilobytes. Specifies the amount of bytes that can be burst at peak speed.", + "title": "Quota: VIF Inbound Burst", + "type": "integer" + }, + "quota:vif_inbound_peak": { + "description": "Network Virtual Interface (VIF) inbound peak in kilobytes per second. Specifies maximum rate at which an interface can receive data.", + "title": "Quota: VIF Inbound Peak", + "type": "integer" + }, + "quota:vif_outbound_average": { + "description": "Network Virtual Interface (VIF) outbound average in kilobytes per second. Specifies average bit rate on the interface being shaped.", + "title": "Quota: VIF Outbound Average", + "type": "integer" + }, + "quota:vif_outbound_burst": { + "description": "Network Virtual Interface (VIF) outbound burst in total kilobytes. Specifies the amount of bytes that can be burst at peak speed.", + "title": "Quota: VIF Outbound Burst", + "type": "integer" + }, + "quota:vif_outbound_peak": { + "description": "Network Virtual Interface (VIF) outbound peak in kilobytes per second. Specifies maximum rate at which an interface can send data.", + "title": "Quota: VIF Outbound Burst", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/Virtual Interface QoS" + } + ], + "schema": "v2/schemas/metadefs/objects" +} 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-req.json new file mode 100644 index 000000000..35b41e345 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-req.json @@ -0,0 +1,12 @@ +{ + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [] +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-response.json new file mode 100644 index 000000000..79db6272c --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-response.json @@ -0,0 +1,16 @@ +{ + "created_at": "2014-09-19T19:20:56Z", + "description": "You can configure the CPU limits with control parameters.", + "name": "CPU Limits", + "properties": { + "quota:cpu_shares": { + "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.", + "title": "Quota: CPU Shares", + "type": "integer" + } + }, + "required": [], + "schema": "/v2/schemas/metadefs/object", + "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits", + "updated_at": "2014-09-19T19:20:56Z" +} 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-req.json new file mode 100644 index 000000000..0b4b314ab --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-req.json @@ -0,0 +1,15 @@ +{ + "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "name": "hypervisor_type", + "title": "Hypervisor Type", + "type": "string" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-response.json new file mode 100644 index 000000000..0b4b314ab --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-response.json @@ -0,0 +1,15 @@ +{ + "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "name": "hypervisor_type", + "title": "Hypervisor Type", + "type": "string" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-details-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-details-response.json new file mode 100644 index 000000000..0b4b314ab --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-details-response.json @@ -0,0 +1,15 @@ +{ + "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "name": "hypervisor_type", + "title": "Hypervisor Type", + "type": "string" +} 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-property-list-response.json new file mode 100644 index 000000000..aeb4a5da9 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-list-response.json @@ -0,0 +1,86 @@ +{ + "properties": { + "hw_disk_bus": { + "description": "Specifies the type of disk controller to attach disk devices to.", + "enum": [ + "scsi", + "virtio", + "uml", + "xen", + "ide", + "usb" + ], + "title": "Disk Bus", + "type": "string" + }, + "hw_machine_type": { + "description": "Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).", + "title": "Machine Type", + "type": "string" + }, + "hw_qemu_guest_agent": { + "description": "It is a daemon program running inside the domain which is supposed to help management applications with executing functions which need assistance of the guest OS. For example, freezing and thawing filesystems, entering suspend. However, guest agent (GA) is not bullet proof, and hostile guest OS can send spurious replies.", + "enum": [ + "yes", + "no" + ], + "title": "QEMU Guest Agent", + "type": "string" + }, + "hw_rng_model": { + "default": "virtio", + "description": "Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default: The generator device is disabled. /dev/random is used as the default entropy source. To specify a physical HW RNG device, use the following option in the nova.conf file: rng_dev_path=/dev/hwrng", + "title": "Random Number Generator Device", + "type": "string" + }, + "hw_scsi_model": { + "default": "virtio-scsi", + "description": "Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI controller device that provides improved scalability and performance, and supports advanced SCSI hardware.", + "title": "SCSI Model", + "type": "string" + }, + "hw_video_model": { + "description": "The video image driver used.", + "enum": [ + "vga", + "cirrus", + "vmvga", + "xen", + "qxl" + ], + "title": "Video Model", + "type": "string" + }, + "hw_video_ram": { + "description": "Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram.", + "title": "Max Video Ram", + "type": "integer" + }, + "hw_vif_model": { + "description": "Specifies the model of virtual network interface device to use. The valid options depend on the configured hypervisor. KVM and QEMU: e1000, ne2k_pci, pcnet, rtl8139, and virtio. VMware: e1000, e1000e, VirtualE1000, VirtualE1000e, VirtualPCNet32, VirtualSriovEthernetCard, and VirtualVmxnet. Xen: e1000, netfront, ne2k_pci, pcnet, and rtl8139.", + "enum": [ + "e1000", + "ne2k_pci", + "pcnet", + "rtl8139", + "virtio", + "e1000", + "e1000e", + "VirtualE1000", + "VirtualE1000e", + "VirtualPCNet32", + "VirtualSriovEthernetCard", + "VirtualVmxnet", + "netfront", + "ne2k_pci" + ], + "title": "Virtual Network Interface", + "type": "string" + }, + "os_command_line": { + "description": "The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).", + "title": "Kernel Command Line", + "type": "string" + } + } +} 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-req.json new file mode 100644 index 000000000..0b4b314ab --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-req.json @@ -0,0 +1,15 @@ +{ + "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "name": "hypervisor_type", + "title": "Hypervisor Type", + "type": "string" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-response.json new file mode 100644 index 000000000..0b4b314ab --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-response.json @@ -0,0 +1,15 @@ +{ + "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.", + "enum": [ + "xen", + "qemu", + "kvm", + "lxc", + "uml", + "vmware", + "hyperv" + ], + "name": "hypervisor_type", + "title": "Hypervisor Type", + "type": "string" +} 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-assoc-create-req.json new file mode 100644 index 000000000..ec5225ecf --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-req.json @@ -0,0 +1,5 @@ +{ + "name": "OS::Cinder::Volume", + "prefix": "hw_", + "properties_target": "image" +} diff --git a/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-response.json new file mode 100644 index 000000000..9176e9a2c --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-response.json @@ -0,0 +1,7 @@ +{ + "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-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json new file mode 100644 index 000000000..672fe4651 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json @@ -0,0 +1,17 @@ +{ + "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-list-response.json b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json new file mode 100644 index 000000000..d2dc34a98 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json @@ -0,0 +1,29 @@ +{ + "resource_types": [ + { + "created_at": "2014-08-28T18:13:04Z", + "name": "OS::Glance::Image", + "updated_at": "2014-08-28T18:13:04Z" + }, + { + "created_at": "2014-08-28T18:13:04Z", + "name": "OS::Cinder::Volume", + "updated_at": "2014-08-28T18:13:04Z" + }, + { + "created_at": "2014-08-28T18:13:04Z", + "name": "OS::Nova::Flavor", + "updated_at": "2014-08-28T18:13:04Z" + }, + { + "created_at": "2014-08-28T18:13:04Z", + "name": "OS::Nova::Aggregate", + "updated_at": "2014-08-28T18:13:04Z" + }, + { + "created_at": "2014-08-28T18:13:04Z", + "name": "OS::Nova::Instance", + "updated_at": "2014-08-28T18:13:04Z" + } + ] +} 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 index 1b5f9fd4e..02beb7e80 100644 --- 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 @@ -1,52 +1,4 @@ { - "name": "image", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "visibility": { - "enum": [ - "public", - "private" - ] - }, - "status": { - "type": "string" - }, - "protected": { - "type": "boolean" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "checksum": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "file": { - "type": "string" - }, - "self": { - "type": "string" - }, - "schema": { - "type": "string" - } - }, "additionalProperties": { "type": "string" }, @@ -63,5 +15,53 @@ "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/schema-metadef-namespace-get-response.json b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json new file mode 100644 index 000000000..f98e4e03a --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json @@ -0,0 +1,212 @@ +{ + "additionalProperties": false, + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "property": { + "additionalProperties": { + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "title", + "type" + ], + "type": "object" + }, + "type": "object" + }, + "stringArray": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "name": "namespace", + "properties": { + "created_at": { + "description": "Date and time of namespace creation (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Provides a user friendly description of the namespace.", + "maxLength": 500, + "type": "string" + }, + "display_name": { + "description": "The user friendly name for the namespace. Used by UI if available.", + "maxLength": 80, + "type": "string" + }, + "namespace": { + "description": "The unique namespace text.", + "maxLength": 80, + "type": "string" + }, + "objects": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "required": { + "$ref": "#/definitions/stringArray" + } + }, + "type": "object" + }, + "type": "array" + }, + "owner": { + "description": "Owner of the namespace.", + "maxLength": 255, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "protected": { + "description": "If true, namespace will not be deletable.", + "type": "boolean" + }, + "resource_type_associations": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "prefix": { + "type": "string" + }, + "properties_target": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "schema": { + "type": "string" + }, + "self": { + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last namespace modification (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "visibility": { + "description": "Scope of namespace accessibility.", + "enum": [ + "public", + "private" + ], + "type": "string" + } + }, + "required": [ + "namespace" + ] +} 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-get-response.json new file mode 100644 index 000000000..5a93f5e4c --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-get-response.json @@ -0,0 +1,243 @@ +{ + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "property": { + "additionalProperties": { + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "title", + "type" + ], + "type": "object" + }, + "type": "object" + }, + "stringArray": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "name": "namespaces", + "properties": { + "first": { + "type": "string" + }, + "namespaces": { + "items": { + "additionalProperties": false, + "name": "namespace", + "properties": { + "created_at": { + "description": "Date and time of namespace creation (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Provides a user friendly description of the namespace.", + "maxLength": 500, + "type": "string" + }, + "display_name": { + "description": "The user friendly name for the namespace. Used by UI if available.", + "maxLength": 80, + "type": "string" + }, + "namespace": { + "description": "The unique namespace text.", + "maxLength": 80, + "type": "string" + }, + "objects": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "required": { + "$ref": "#/definitions/stringArray" + } + }, + "type": "object" + }, + "type": "array" + }, + "owner": { + "description": "Owner of the namespace.", + "maxLength": 255, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "protected": { + "description": "If true, namespace will not be deletable.", + "type": "boolean" + }, + "resource_type_associations": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "prefix": { + "type": "string" + }, + "properties_target": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "schema": { + "type": "string" + }, + "self": { + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last namespace modification (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "visibility": { + "description": "Scope of namespace accessibility.", + "enum": [ + "public", + "private" + ], + "type": "string" + } + }, + "required": [ + "namespace" + ] + }, + "type": "array" + }, + "next": { + "type": "string" + }, + "schema": { + "type": "string" + } + } +} 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-get-response.json new file mode 100644 index 000000000..ac42e8564 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-get-response.json @@ -0,0 +1,152 @@ +{ + "additionalProperties": false, + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "property": { + "additionalProperties": { + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "title", + "type" + ], + "type": "object" + }, + "type": "object" + }, + "stringArray": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "name": "object", + "properties": { + "created_at": { + "description": "Date and time of object creation (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "schema": { + "type": "string" + }, + "self": { + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last object modification (READ-ONLY)", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "name" + ] +} 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-get-response.json new file mode 100644 index 000000000..fb24c87a9 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-get-response.json @@ -0,0 +1,183 @@ +{ + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "property": { + "additionalProperties": { + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "title", + "type" + ], + "type": "object" + }, + "type": "object" + }, + "stringArray": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "name": "objects", + "properties": { + "first": { + "type": "string" + }, + "next": { + "type": "string" + }, + "objects": { + "items": { + "additionalProperties": false, + "name": "object", + "properties": { + "created_at": { + "description": "Date and time of object creation (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/property" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "schema": { + "type": "string" + }, + "self": { + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last object modification (READ-ONLY)", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "type": "array" + }, + "schema": { + "type": "string" + } + } +} 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-get-response.json new file mode 100644 index 000000000..915a9b9fb --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-get-response.json @@ -0,0 +1,145 @@ +{ + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "stringArray": { + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "name": "properties", + "properties": { + "first": { + "type": "string" + }, + "next": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "additionalProperties": false, + "name": "property", + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "type", + "title" + ] + }, + "type": "object" + }, + "schema": { + "type": "string" + } + } +} 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-get-response.json new file mode 100644 index 000000000..aad9ebcc1 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-get-response.json @@ -0,0 +1,115 @@ +{ + "additionalProperties": false, + "definitions": { + "positiveInteger": { + "minimum": 0, + "type": "integer" + }, + "positiveIntegerDefault0": { + "allOf": [ + { + "$ref": "#/definitions/positiveInteger" + }, + { + "default": 0 + } + ] + }, + "stringArray": { + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "name": "property", + "properties": { + "additionalItems": { + "type": "boolean" + }, + "default": {}, + "description": { + "type": "string" + }, + "enum": { + "type": "array" + }, + "items": { + "properties": { + "enum": { + "type": "array" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": { + "$ref": "#/definitions/positiveInteger" + }, + "maxLength": { + "$ref": "#/definitions/positiveInteger" + }, + "maximum": { + "type": "number" + }, + "minItems": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minLength": { + "$ref": "#/definitions/positiveIntegerDefault0" + }, + "minimum": { + "type": "number" + }, + "name": { + "type": "string" + }, + "pattern": { + "format": "regex", + "type": "string" + }, + "readonly": { + "type": "boolean" + }, + "required": { + "$ref": "#/definitions/stringArray" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string", + null + ], + "type": "string" + }, + "uniqueItems": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "type", + "title", + "name" + ] +} 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-get-response.json new file mode 100644 index 000000000..45aa141b3 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-get-response.json @@ -0,0 +1,34 @@ +{ + "additionalProperties": false, + "name": "resource_type_association", + "properties": { + "created_at": { + "description": "Date and time of resource type association (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Resource type names should be aligned with Heat resource types whenever possible: http://docs.openstack.org/developer/heat/template_guide/openstack.html", + "maxLength": 80, + "type": "string" + }, + "prefix": { + "description": "Specifies the prefix to use for the given resource type. Any properties in the namespace should be prefixed with this prefix when being applied to the specified resource type. Must include prefix separator (e.g. a colon :). It is important to note that the same base property key can require different prefixes depending on the target resource type. For example: The desired virtual CPU topology can be set on both images and flavors via metadata. The keys have different prefixes on images than on flavors On flavors keys are prefixed with 'hw:', but on images the keys are prefixed with 'hw_'.", + "maxLength": 80, + "type": "string" + }, + "properties_target": { + "description": "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.", + "maxLength": 80, + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last resource type association modification (READ-ONLY)", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "name" + ] +} 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-get-response.json new file mode 100644 index 000000000..c63116824 --- /dev/null +++ b/api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-get-response.json @@ -0,0 +1,65 @@ +{ + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "name": "resource_type_associations", + "properties": { + "first": { + "type": "string" + }, + "next": { + "type": "string" + }, + "resource_type_associations": { + "items": { + "additionalProperties": false, + "name": "resource_type_association", + "properties": { + "created_at": { + "description": "Date and time of resource type association (READ-ONLY)", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Resource type names should be aligned with Heat resource types whenever possible: http://docs.openstack.org/developer/heat/template_guide/openstack.html", + "maxLength": 80, + "type": "string" + }, + "prefix": { + "description": "Specifies the prefix to use for the given resource type. Any properties in the namespace should be prefixed with this prefix when being applied to the specified resource type. Must include prefix separator (e.g. a colon :). It is important to note that the same base property key can require different prefixes depending on the target resource type. For example: The desired virtual CPU topology can be set on both images and flavors via metadata. The keys have different prefixes on images than on flavors On flavors keys are prefixed with 'hw:', but on images the keys are prefixed with 'hw_'.", + "maxLength": 80, + "type": "string" + }, + "properties_target": { + "description": "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.", + "maxLength": 80, + "type": "string" + }, + "updated_at": { + "description": "Date and time of the last resource type association modification (READ-ONLY)", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "type": "array" + }, + "schema": { + "type": "string" + } + } +} 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/schemas-image-get-response.json index aa3610878..18d25c1f8 100644 --- 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/schemas-image-get-response.json @@ -1,4 +1,21 @@ { + "additionalProperties": { + "type": "string" + }, + "links": [ + { + "href": "{self}", + "rel": "self" + }, + { + "href": "{file}", + "rel": "enclosure" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], "name": "image", "properties": { "architecture": { @@ -165,22 +182,5 @@ ], "type": "string" } - }, - "additionalProperties": { - "type": "string" - }, - "links": [ - { - "href": "{self}", - "rel": "self" - }, - { - "href": "{file}", - "rel": "enclosure" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ] + } } 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/schemas-image-member-get-response.json index 611f0a245..5ad359d7d 100644 --- 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/schemas-image-member-get-response.json @@ -14,6 +14,9 @@ "description": "An identifier for the image member (tenantId)", "type": "string" }, + "schema": { + "type": "string" + }, "status": { "description": "The status of this image member", "enum": [ @@ -26,9 +29,6 @@ "updated_at": { "description": "Date and time of last modification of image member", "type": "string" - }, - "schema": { - "type": "string" } } } 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-get-response.json index 39b0d4117..56a160266 100644 --- 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-get-response.json @@ -1,4 +1,10 @@ { + "links": [ + { + "href": "{schema}", + "rel": "describedby" + } + ], "name": "members", "properties": { "members": { @@ -18,6 +24,9 @@ "description": "An identifier for the image member (tenantId)", "type": "string" }, + "schema": { + "type": "string" + }, "status": { "description": "The status of this image member", "enum": [ @@ -30,9 +39,6 @@ "updated_at": { "description": "Date and time of last modification of image member", "type": "string" - }, - "schema": { - "type": "string" } } }, @@ -41,11 +47,5 @@ "schema": { "type": "string" } - }, - "links": [ - { - "href": "{schema}", - "rel": "describedby" - } - ] + } } 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-get-response.json index 3b50c591a..78e4e5419 100644 --- 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-get-response.json @@ -1,4 +1,18 @@ { + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], "name": "images", "properties": { "first": { @@ -6,6 +20,23 @@ }, "images": { "items": { + "additionalProperties": { + "type": "string" + }, + "links": [ + { + "href": "{self}", + "rel": "self" + }, + { + "href": "{file}", + "rel": "enclosure" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], "name": "image", "properties": { "architecture": { @@ -172,24 +203,7 @@ ], "type": "string" } - }, - "additionalProperties": { - "type": "string" - }, - "links": [ - { - "href": "{self}", - "rel": "self" - }, - { - "href": "{file}", - "rel": "enclosure" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ] + } }, "type": "array" }, @@ -199,19 +213,5 @@ "schema": { "type": "string" } - }, - "links": [ - { - "href": "{first}", - "rel": "first" - }, - { - "href": "{next}", - "rel": "next" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ] + } }