openstack/api-site
Code Issues Proposed changes

Add documentation for Glance Metadata Definitions Catalog - API

Browse Source 
Change-Id: Ide07b75c846caa2a1c57060cc6c71b7859a78258
Closes-Bug: #1363615
This commit is contained in:
Lakshmi N Sampath 2014-09-12 14:36:06 -07:00 committed by Diane Fleming
parent e7040ded4f
commit bfefd9be36
45 changed files with 5362 additions and 1337 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/pom.xml
View File

@ -36,7 +36,7 @@
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<execution>
<execution>
<id>os-api-ref</id>
<goals>
<goal>generate-html</goal>

122
api-ref/src/docbkx/ch_images-v2.xml
View File

@ -108,4 +108,126 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-metadef-resourcetype-v2">
<title>Metadata definition resource types</title>
<para>
Lists resource types. Also, creates, lists, and removes resource
type associations in a specified namespace. (Since API v2.0.)
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl#metadefs">
<wadl:method href="#listResourceTypes-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl#resource_types">
<wadl:method href="#createResourceTypeAssoc-v2"/>
<wadl:method href="#listResourceTypeAssocs-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl#name">
<wadl:method href="#deleteResourceTypeAssoc-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-metadef-namespace-v2">
<title>Metadata definition namespaces</title>
<para>
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.)
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-namespace-v2.wadl#namespaces">
<wadl:method href="#createNamespace-v2"/>
<wadl:method href="#listNamespaces-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-namespace-v2.wadl#namespace">
<wadl:method href="#getNamespace-v2"/>
<wadl:method href="#updateNamespace-v2"/>
<wadl:method href="#deleteNamespace-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-metadef-property-v2.wadl">
<title>Metadata definition properties</title>
<para>
Creates, lists, gets details for, updates, and deletes metadata
definition properties. (Since API v2.0.)
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-property-v2.wadl#properties">
<wadl:method href="#createProperty-v2"/>
<wadl:method href="#listProperties-v2"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-property-v2.wadl#property_name">
<wadl:method href="#getProperty-v2"/>
<wadl:method href="#updateProperty-v2"/>
<wadl:method href="#deleteProperty-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-metadef-object-v2">
<title>Metadata definition objects</title>
<para>
Creates, lists, gets details for, updates, and deletes metadata
definition objects. (Since API v2.0.)
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-object-v2.wadl#objects">
<wadl:method href="#createObject-v2"/>
<wadl:method href="#listObjects-v2"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-object-v2.wadl#object_name">
<wadl:method href="#getObject-v2"/>
<wadl:method href="#updateObject-v2"/>
<wadl:method href="#deleteObject-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-metadef-schemas-v2">
<title>Metadata definition schemas</title>
<para>
Gets a JSON-schema document that represents a metadata definition
entity.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#namespace">
<wadl:method href="#getMetadefNamespaceSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#namespaces">
<wadl:method href="#getMetadefNamespacesSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#object">
<wadl:method href="#getMetadefObjectSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#objects">
<wadl:method href="#getMetadefObjectsSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#property">
<wadl:method href="#getMetadefPropertySchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#properties">
<wadl:method href="#getMetadefPropertiesSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#resource_type">
<wadl:method href="#getMetadefResTypeAssocSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#resource_types">
<wadl:method href="#getMetadefResTypeAssocsSchema"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

4
api-ref/src/wadls/common_project.ent
View File

@ -24,13 +24,13 @@
parameter value in a subsequent limited request.
</para>
</wadl:doc>
</param>
'>
</param>'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
<!ENTITY PATCH '<command xmlns="http://docbook.org/ns/docbook">PATCH</command>'>
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">

1169
api-ref/src/wadls/image-api/src/v2/common.ent
View File

File diff suppressed because it is too large Load Diff

1685
api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
View File

File diff suppressed because it is too large Load Diff

357
api-ref/src/wadls/image-api/src/v2/os-metadef-namespace-v2.wadl Normal file
View File

@ -0,0 +1,357 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-image-2.2.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-metadef-namespace-v2">
<resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs">
<resource id="namespaces" type="#NamespaceList" path="namespaces">
<method href="#createNamespace-v2"/>
<method href="#listNamespaces-v2"/>
<resource path="{namespace}" id="namespace">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Unique namespace.
</para>
</wadl:doc>
</param>
<method href="#getNamespace-v2"/>
<method href="#updateNamespace-v2"/>
<method href="#deleteNamespace-v2"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Namespace methods -->
<method name="POST" id="createNamespace-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create namespace">
<para role="shortdesc">
Creates a namespace.
</para>
<para>
The namespace is created with a <code>Location</code> header
that contains the newly-created URI for the namespace.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="image">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-namespace-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A namespace name that is unique across all users.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="display_name" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
User-friendly name that can be used in UI to
display the namespace name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Detailed description for the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Namespace visibility. Valid value is public or
private. Default is private.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="protected" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Namespace protection for deletion. Valid value is
true or false. Default is false.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more property definitions in the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="objects" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more object definitions in the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resource_type_associations" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more resource types that are associated
with this namespace.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-namespace-create-response.json"/>
</wadl:doc>
&metadefNamespaceParameter; &metadefNSDisplayNameParameter;
&metadefNSDescParameter; &metadefNSVisibilityParameter;
&metadefNSProtectedParameter; &metadefPropertiesParameter;
&metadefObjectsParameter; &metadefResTypeAssocsParameter;
</representation>
</response>
</method>
<method name="GET" id="listNamespaces-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List namespaces">
<para role="shortdesc">Lists public namespaces.</para>
<para>
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 <code>next</code> link and use it as the
URI in a subsequent HTTP GET request. Follow this pattern
until a <code>next</code> link is no longer provided. The
<code>next</code> link preserves any query parameters that you
send in your initial request. You can use the
<code>first</code> link to return to the first page in the
collection. If you prefer to paginate through namespaces
manually, use the <code>limit</code> and <code>marker</code>
parameters.
</para>
<para>
The list operation accepts the <code>resource_types</code> and
<code>visibility</code> query parameters, which let you filter
the results in the returned collection.
</para>
<para>
To sort the results of this operation, use the
<code>sort_key</code> and <code>sort_dir</code> parameters.
The API uses the natural sorting order in the namespace
attribute that you provide as the <code>sort_key</code>
parameter.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&limitMarkerReqParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="visibility"
style="query" required="false" type="imageapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Filter parameter. Namespace visibility. Valid values are
<code>public</code> and <code>private</code>.
Default is <code>public</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="resource_types"
style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Filter parameter. Specify this value as comma-
separated list. For example, send the
<code>resource_types</code> filter of
<code>OS::Glance::Image,OS::Nova::Flavor</code> to
filter the namespaces by the specified resource
types.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Sort key. Use attributes like <code>namespace</code>
for sorting. Default is <code>created_at</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Sort direction. Valid values are <code>asc</code>
(ascending) and <code>desc</code> (descending). Default is
<code>desc</code>.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-namespace-list-response.json"/>
</wadl:doc>
&namespacesParameter; &metadefNamespaceParameter;
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
&metadefNSVisibilityParameter; &metadefNSProtectedParameter;
&metadefResTypeAssocsParameter;
</representation>
</response>
</method>
<method name="GET" id="getNamespace-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get namespaces details">
<para role="shortdesc">
Gets details for a specified namespace.
</para>
<para>
The response body shows a single namespace entity with all
details including properties and objects.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-namespace-details-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="PUT" id="updateNamespace-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update namespace">
<para role="shortdesc">Updates a specified namespace.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-namespace-update-req.json"/>
</wadl:doc>
&metadefNamespace_idParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-namespace-update-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteNamespace-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete namespace">
<para role="shortdesc">
Deletes a specified namespace and its properties,
objects, and any resource type associations.
</para>
<para>
You cannot delete namespaces with the <code>protected</code>
attribute set to true (boolean); the response returns the HTTP
403 status code.
</para>
<para>
To delete a namespace, you must first make an update namespace
request to set the <code>protected</code> attribute to false
(boolean) on the namespace. Then, delete the namespace.
</para>
<para>
If the operation succeeds, the response returns the HTTP 204
status code.
</para>
<para>
If you try to remove a namespace with the
<code>protected</code> attribute set to true (boolean), the
operation fails and the response returns the HTTP 403 error
code.
</para>
</wadl:doc>
<response status="204"/>
<response status="403"/>
</method>
</application>

273
api-ref/src/wadls/image-api/src/v2/os-metadef-object-v2.wadl Normal file
View File

@ -0,0 +1,273 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-image-2.2.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-metadef-object-v2">
<resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs">
<resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace">
<resource id="objects" type="#ObjectList" path="objects">
<method href="#createObject-v2"/>
<method href="#listObjects-v2"/>
<resource path="{object_name}" id="object_name">
<method href="#getObject-v2"/>
<method href="#updateObject-v2"/>
<method href="#deleteObject-v2"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Property methods -->
<method name="POST" id="createObject-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create object">
<para role="shortdesc">
Creates an object definition in a specified
namespace.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="image">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-object-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The namespace is unique across all
users.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="display_name" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>User-friendly name to use in a UI to display the namespace name.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Detailed description for the namespace.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Namespace visibility. Public or private.
Default is private.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="protected" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Namespace protection for deletion. Valid value is true or false.
Default is false.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property definitions, if any, for the namespace.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="objects" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Object definitions, if any, for the namespace.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resource_type_associations" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Resource types, if any, that are associated with this namespace</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-object-create-response.json"/>
</wadl:doc> &metadefNamespaceParameter; &metadefNSDisplayNameParameter;
&metadefNSDescParameter; &metadefNSVisibilityParameter;
&metadefNSProtectedParameter; &metadefPropertiesParameter;
&metadefObjectsParameter; &metadefResTypeAssocsParameter;
</representation>
</response>
</method>
<method name="GET" id="listObjects-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List objects">
<para role="shortdesc">Lists object definitions within
a namespace.</para>
<para>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
<code>next</code> link and use it as the URI in a
subsequent HTTP GET request. You should follow this
pattern until a <code>next</code> link is no longer
provided. The next link preserves any query parameters
that you send in your initial request. You can use the
<code>first</code> link to jump back to the first
page of the collection. If you prefer to paginate
through namespaces manually, use the <code>limit</code>
and <code>marker</code> parameters.</para>
<para>The list operation accepts <code>resource_types</code> and
<code>visibility</code> as query parameters that let you
filter the results of the returned collection.</para>
<para>For example, sending a <code>resource_types</code> filter
of <code>OS::Glance::Image,OS::Nova::Flavor</code> filters
the namespaces to include only namespaces that are associated
to the given resource types.</para>
<para>You can sort the results of this operation by using
the <code>sort_key</code> and <code>sort_dir</code>
parameters. The API uses the natural sorting of
whatever namespace attribute is provided as the
<code>sort_key</code>.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespaceListReqParameters; </representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-object-list-response.json"/>
</wadl:doc> &namespacesParameter; &metadefNamespaceParameter;
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
&metadefNSVisibilityParameter; &metadefNSProtectedParameter;
&metadefResTypeAssocsParameter; </representation>
</response>
</method>
<method name="GET" id="getObject-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get object definition">
<para role="shortdesc">Gets definition for a specified object.
</para>
<para>Response body is a single object entity.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter;</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-object-details-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="PUT" xml:id="updateObject-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update object definition">
<para role="shortdesc">
Updates a specified object definition.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-object-update-req.json"/>
</wadl:doc> &metadefNamespace_idParameter; </representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-object-update-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteObject-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete property definition">
<para role="shortdesc">
Deletes a specified object definition within a namespace.
</para>
<para>
You cannot delete objects in a namespace with the 'protected'
attribute set to true (boolean); the response returns
the HTTP 403 status code.
</para>
<para>
You must first set the <code>protected</code> attribute to
false (boolean) on the namespace and then perform the delete.
The response is empty and returns the HTTP 204 status code.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter; </representation>
</request>
<response status="204"/>
<response status="403"/>
</method>
</application>

517
api-ref/src/wadls/image-api/src/v2/os-metadef-property-v2.wadl Normal file
View File

@ -0,0 +1,517 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-image-2.2.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-metadef-property-v2">
<resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs">
<resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace">
<resource id="properties" type="#PropertyList"
path="properties">
<method href="#createProperty-v2"/>
<method href="#listProperties-v2"/>
<resource path="{property_name}" id="property_name">
<method href="#getProperty-v2"/>
<method href="#updateProperty-v2"/>
<method href="#deleteProperty-v2"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Property methods -->
<method name="POST" id="createProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create property">
<para role="shortdesc">Creates a property definition within a
namespace. Schema is subset of JSON Property definition schema
</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="image">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-property-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Name of the property.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="title" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property title.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property type
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enum" style="plain" type="xsd:enum"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Enumeration of property values.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="items" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>specifies schema for the items in an
array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minimum" style="plain" type="xsd:int"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maximum" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pattern" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A regular expression (ECMA 262) that
a string value must match.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uniqueItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>whether all the values in the array
must be distinct.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="additionalItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If you use <i>tuple-typing</i>, describes extra
items. If the value of <code>items</code> is an
array and the instance is longer than the list of
schemas in <code>items</code>, the schema in this
property describes the additional items.
</para>
<para>
If this value is false, the instance cannot be
longer than the number of schemas listed in
<code>items</code>.
</para>
<para>
A value of true indicates an empty schema, or
anything goes.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-property-create-response.json"/>
</wadl:doc> &metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
&metadefPropertyUniqueItemsParameter;
&metadefPropertyAdditionalItemsParameter;
</representation>
</response>
</method>
<method name="GET" id="listProperties-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List properties">
<para role="shortdesc">Lists property definitions within
a namespace.</para>
<para>Returns a list of property definitions in a
namespace.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter;</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-property-list-response.json"/>
</wadl:doc> &metadefPropertyListParameter;
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
&metadefPropertyUniqueItemsParameter;
&metadefPropertyAdditionalItemsParameter;
</representation>
</response>
</method>
<method name="GET" id="getProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get property definition">
<para role="shortdesc">Gets definition for a specified property.
</para>
<para>Response body is a single property entity.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter;
&metadefPropertyNameIdParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-property-details-response.json"/>
</wadl:doc>
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
&metadefPropertyUniqueItemsParameter;
&metadefPropertyAdditionalItemsParameter;
</representation>
</response>
</method>
<method name="PUT" id="updateProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update property definition">
<para role="shortdesc">Updates a specified property definition.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="image">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-property-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Name of the property.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="title" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property title.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property type
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enum" style="plain" type="xsd:enum"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Enumeration of property values.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="items" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>specifies schema for the items in an
array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minimum" style="plain" type="xsd:int"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maximum" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pattern" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A regular expression (ECMA 262) that
a string value must match.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uniqueItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>whether all the values in the array
must be distinct.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="additionalItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If you use <i>tuple-typing</i>, describes extra
items. If the value of <code>items</code> is an
array and the instance is longer than the list of
schemas in <code>items</code>, the schema in this
property describes the additional items.
</para>
<para>
If this value is false, the instance cannot be
longer than the number of schemas listed in
<code>items</code>.
</para>
<para>
A value of true indicates an empty schema, or
anything goes.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-property-update-response.json"/>
</wadl:doc>
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
&metadefPropertyUniqueItemsParameter;
&metadefPropertyAdditionalItemsParameter;
</representation>
</response>
</method>
<method name="DELETE" id="deleteProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Remove property definition">
<para role="shortdesc">
Removes a specified property definition in a specified
namespace.
</para>
<para>
To remove a property, first make an update namespace request
to set the <code>protected</code> attribute to false (boolean)
on the namespace. Then, remove the property. If the operation
succeeds, the response returns the HTTP 204 status code.
</para>
<para>
If you try to remove a property in a namespace
with the <code>protected</code> attribute set to true
(boolean), the operation fails and the response returns the
HTTP 403 error code.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter;
&metadefPropertyNameIdParameter; </representation>
</request>
<response status="204"/>
<response status="403"/>
</method>
</application>

205
api-ref/src/wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl Normal file
View File

@ -0,0 +1,205 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-image-2.2.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-metadef-resourcetype-v2">
<resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs">
<method href="#listResourceTypes-v2"/>
<resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace">
<resource id="resource_types" type="#ResourceTypeList"
path="resource_types">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Unique namespace.
</para>
</wadl:doc>
</param>
<method href="#createResourceTypeAssoc-v2"/>
<method href="#listResourceTypeAssocs-v2"/>
<resource path="{name}" id="name">
<param xmlns="http://wadl.dev.java.net/2009/02" name="name"
style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Name of the resource type.</para>
</wadl:doc>
</param>
<method href="#deleteResourceTypeAssoc-v2"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Property methods -->
<method name="POST" id="createResourceTypeAssoc-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create resource type association">
<para role="shortdesc">Creates a resource type association
in a namespace.</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="image">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-resource-type-assoc-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Name of the resource type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="prefix" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
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
(<code>:</code>) character to prefix any
properties in the namespace that you want to apply
to the specified resource type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties_target" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
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 <code>properties_target</code>
parameter enables a namespace target to remove the
ambiguity.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-resource-type-assoc-create-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="listResourceTypes-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List resource types">
<para role="shortdesc">Lists resource types.</para>
<para>
Lists all possible resource types. You can assign metadata
definition namespaces to these resource types. See the
metadata definition resource types section.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-resource-type-list-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="listResourceTypeAssocs-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List resource type associations">
<para role="shortdesc">
Lists resource type associations in a specified namespace.
</para>
<para>
The response body lists resource type association entities.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/metadef-resource-type-assoc-list-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteResourceTypeAssoc-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Remove resource type association">
<para role="shortdesc">
Removes a specified resource type association in a specified
namespace.
</para>
<para>
To remove an association, first make an update namespace
request to set the <code>protected</code> attribute to false
(boolean) on the namespace. Then, remove the association. If
the operation succeeds, the response returns the HTTP 204
status code.
</para>
<para>
If you try to remove resource type associations in a namespace
with the <code>protected</code> attribute set to true
(boolean), the operation fails and the response returns the
HTTP 403 error code.
</para>
</wadl:doc>
<response status="204"/>
<response status="403"/>
</method>
</application>

253
api-ref/src/wadls/image-api/src/v2/os-metadef-schemas-v2.wadl Normal file
View File

@ -0,0 +1,253 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-metadef-schemas-2.2.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-metadef-schemas-v2">
<resource id="v2" path="//v2">
<resource id="schemas" path="schemas">
<resource id="metadefs" path="metadefs">
<resource id="namespace" type="#SchemaList"
path="namespace">
<method href="#getMetadefNamespaceSchema"/>
</resource>
<resource id="namespaces" type="#SchemaList"
path="namespaces">
<method href="#getMetadefNamespacesSchema"/>
</resource>
<resource id="object" type="#SchemaList"
path="object">
<method href="#getMetadefObjectSchema"/>
</resource>
<resource id="objects" type="#SchemaList"
path="objects">
<method href="#getMetadefObjectsSchema"/>
</resource>
<resource id="property" type="#SchemaList"
path="property">
<method href="#getMetadefPropertySchema"/>
</resource>
<resource id="properties" type="#SchemaList"
path="properties">
<method href="#getMetadefPropertiesSchema"/>
</resource>
<resource id="resource_type" type="#SchemaList"
path="resource_type">
<method href="#getMetadefResTypeAssocSchema"/>
</resource>
<resource id="resource_types" type="#SchemaList"
path="resource_types">
<method href="#getMetadefResTypeAssocsSchema"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="getMetadefNamespaceSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition namespace schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition namespace entity. (Since API v2.1.)</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-namespace-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefNamespacesSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition namespaces schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition namespace(s) entity. (Since API v2.1.)</para>
<para>A namespaces entity is a container of namespace
entities.</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-namespaces-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefObjectSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition object schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition object entity. (Since API v2.1.)</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-object-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefObjectsSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition objects schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition object(s) entity. (Since API v2.1.)</para>
<para>An objects entity is a container of object
entities.</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-objects-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefPropertySchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition property schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition property entity. (Since API v2.1.)</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-property-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefPropertiesSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition properties schema">
<para role="shortdesc">Gets a json-schema document that
represents a metadata definition properties entity. (Since API v2.1.)</para>
<para>An properties entity is a container of property
entities.</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-properties-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefResTypeAssocSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition namespace resource type association schema">
<para role="shortdesc">
Gets a json-schema document that represents a metadata
definition namespace resource type association entity. (Since
API v2.1.)
</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-resource-type-association-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getMetadefResTypeAssocsSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get Metadata definition namespace resource type association(s) schema">
<para role="shortdesc">
Gets a json-schema document that represents a metadata
definition namespace resource type association(s) entity.
(Since API v2.1.)
</para>
<para>A resource type associations entity is a container of resource type association
entities.</para>
<para>The following schema is solely an example. Consider
only the response to the API call as
authoritative.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="samples/schema-metadef-resource-type-associations-get-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>

39
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-req.json Normal file
View File

@ -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"
}

41
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-create-response.json Normal file
View File

@ -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"
}

103
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-details-response.json Normal file
View File

@ -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"
}

96
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-list-response.json Normal file
View File

@ -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"
}

7
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-req.json Normal file
View File

@ -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"
}

12
api-ref/src/wadls/image-api/src/v2/samples/metadef-namespace-update-response.json Normal file
View File

@ -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"
}

24
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-req.json Normal file
View File

@ -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": []
}

28
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-create-response.json Normal file
View File

@ -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"
}

28
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-details-response.json Normal file
View File

@ -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"
}

112
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-list-response.json Normal file
View File

@ -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"
}

12
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-req.json Normal file
View File

@ -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": []
}

16
api-ref/src/wadls/image-api/src/v2/samples/metadef-object-update-response.json Normal file
View File

@ -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"
}

15
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-req.json Normal file
View File

@ -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"
}

15
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-create-response.json Normal file
View File

@ -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"
}

15
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-details-response.json Normal file
View File

@ -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"
}

86
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-list-response.json Normal file
View File

@ -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"
}
}
}

15
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-req.json Normal file
View File

@ -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"
}

15
api-ref/src/wadls/image-api/src/v2/samples/metadef-property-update-response.json Normal file
View File

@ -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"
}

5
api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-req.json Normal file
View File

@ -0,0 +1,5 @@
{
"name": "OS::Cinder::Volume",
"prefix": "hw_",
"properties_target": "image"
}

7
api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-create-response.json Normal file
View File

@ -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"
}

17
api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-assoc-list-response.json Normal file
View File

@ -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"
}
]
}

29
api-ref/src/wadls/image-api/src/v2/samples/metadef-resource-type-list-response.json Normal file
View File

@ -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"
}
]
}

98
api-ref/src/wadls/image-api/src/v2/samples/schema-image-get-response.json
View File

@ -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"
]
}
}
}

212
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespace-get-response.json Normal file
View File

@ -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"
]
}

243
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-namespaces-get-response.json Normal file
View File

@ -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"
}
}
}

152
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-object-get-response.json Normal file
View File

@ -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"
]
}

183
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-objects-get-response.json Normal file
View File

@ -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"
}
}
}

145
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-properties-get-response.json Normal file
View File

@ -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"
}
}
}

115
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-property-get-response.json Normal file
View File

@ -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"
]
}

34
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-association-get-response.json Normal file
View File

@ -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"
]
}

65
api-ref/src/wadls/image-api/src/v2/samples/schema-metadef-resource-type-associations-get-response.json Normal file
View File

@ -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"
}
}
}

36
api-ref/src/wadls/image-api/src/v2/samples/schemas-image-get-response.json
View File

@ -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"
}
]
}
}

6
api-ref/src/wadls/image-api/src/v2/samples/schemas-image-member-get-response.json
View File

@ -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"
}
}
}

20
api-ref/src/wadls/image-api/src/v2/samples/schemas-image-members-get-response.json
View File

@ -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"
}
]
}
}

66
api-ref/src/wadls/image-api/src/v2/samples/schemas-images-get-response.json
View File

@ -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"
}
]
}
}