341 lines
15 KiB
XML
341 lines
15 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
|
|
<!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:csapi="http://docs.openstack.org/compute/api/v2"
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<resources base="https://servers.api.openstack.com"
|
|
xml:id="os-flavor-access-v2">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
title="Flavor access" xml:lang="EN"/>
|
|
<resource id="version" type="#VersionDetails" path="v2/">
|
|
<resource id="tenant_id" path="{tenant_id}">
|
|
<param name="tenant_id" style="template"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<para>The ID for the tenant or account in a
|
|
multi-tenancy cloud.</para></wadl:doc>
|
|
</param>
|
|
<resource id="flavors" path="flavors">
|
|
<method href="#detailAccess"/>
|
|
<method href="#createAccess"/>
|
|
<resource path="{flavor_id}" id="flavor_id">
|
|
<param name="flavor_id" style="template"
|
|
type="csapi:uuid" required="true">
|
|
<wadl:doc
|
|
xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para role="shortdesc">
|
|
The ID of the flavor of interest to
|
|
you.</para></wadl:doc>
|
|
</param>
|
|
<method href="#showAccess"/>
|
|
<resource path="os-flavor-access"
|
|
id="os-flavor-access">
|
|
<method href="#listAccess"/>
|
|
</resource>
|
|
<resource path="action" id="action">
|
|
<method href="#addTenantAccess"/>
|
|
<method href="#removeTenantAccess"/>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resources>
|
|
<method name="GET" id="detailAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="List flavors with access type">
|
|
<para role="shortdesc">Lists flavors and includes the
|
|
access type, which is public or private.</para>
|
|
</wadl:doc>
|
|
<response status="200"> &flavorRespParameters; <param
|
|
name="os-flavor-access:is_public" style="plain"
|
|
required="true" type="xsd:Boolean">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Set to true if access is
|
|
public.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-detail-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-detail-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="POST" id="createAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Create private flavor">
|
|
<para role="shortdesc">Creates a private flavor.</para>
|
|
</wadl:doc>
|
|
<request> &flavorReqParameters; <param
|
|
name="os-flavor-access:is_public" style="plain"
|
|
required="true" type="xsd:Boolean">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Set to true if access is
|
|
public. Set to false if access is
|
|
private.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-create-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-create-req.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200"> &flavorRespParameters; <param
|
|
name="os-flavor-access:is_public" style="plain"
|
|
required="true" type="xsd:Boolean">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Set to true if access is
|
|
public.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-create-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-create-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="GET" id="showAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Show flavor access type">
|
|
<para role="shortdesc">Gets the flavor access type, which
|
|
is public or private.</para>
|
|
</wadl:doc>
|
|
<response status="200"> &flavorRespParameters; <param
|
|
name="os-flavor-access:is_public" style="plain"
|
|
required="true" type="xsd:Boolean">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Set to true if access is
|
|
public.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-show-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-show-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="GET" id="listAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="List tenants with access to private flavor">
|
|
<para role="shortdesc">Lists tenants with access to the
|
|
specified private flavor.</para>
|
|
</wadl:doc>
|
|
<response status="200">
|
|
<param name="flavor_id" style="plain" required="true"
|
|
type="xsd:int">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The flavor
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<param name="tenant_id" style="plain" required="true"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The tenant
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-list-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-list-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="POST" id="addTenantAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Add access to private flavor">
|
|
<para role="shortdesc">Gives a specified tenant access to
|
|
the specified private flavor.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<param name="addTenantAccess" style="plain"
|
|
required="true" type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Specify the
|
|
<code>addTenantAccess</code>
|
|
action.</para></wadl:doc>
|
|
</param>
|
|
<param name="tenant" style="plain" required="true"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The name of the tenant to
|
|
which to give access.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<param name="flavor_id" style="plain" required="true"
|
|
type="xsd:int">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The flavor
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<param name="tenant_id" style="plain" required="true"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The tenant
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="DELETE" id="removeTenantAccess">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Delete access from private flavor">
|
|
<para role="shortdesc">Revokes access from the specified
|
|
tenant for the specified private flavor.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<param name="removeTenantAccess" style="plain"
|
|
required="true" type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>Specify the
|
|
<code>removeTenantAccess</code>
|
|
action.</para></wadl:doc>
|
|
</param>
|
|
<param name="tenant" style="plain" required="true"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The name of the tenant from
|
|
which to revoke access.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<param name="flavor_id" style="plain" required="true"
|
|
type="xsd:int">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The flavor
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<param name="tenant_id" style="plain" required="true"
|
|
type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN"><para>The tenant
|
|
ID.</para></wadl:doc>
|
|
</param>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.xml"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
</application>
|