openstack/api-site
Code Issues Proposed changes

Merge "Add GET /extensions call"

Browse Source
This commit is contained in:
Jenkins
2016-01-18 21:53:50 +00:00
committed by Gerrit Code Review
parent a433f7e42b 2f9c2b85e5
commit a78711d1a0
8 changed files with 132 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
api-ref/src/docbkx/ch_identity-admin-v2.xml
View File

@@ -8,6 +8,22 @@
version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2"
role="api-reference">
<title>Identity Admin API v2.0 (SUPPORTED)</title>
<para>Gets an authentication token that permits access to the Compute API.</para>
<section xml:id="admin-versions">
<title>Versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#admin-version">
<wadl:method href="#admin-getVersionInfo"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="admin-extensions">
<title>Extensions</title>
<para>
For information about Identity API v2.0 extensions, see <link
xlink:href="http://developer.openstack.org/api-ref-identity-v2.html#identity-api-extensions">Extensions</link>.
</para>
</section>
<section xml:id="admin-tokens">
<title>Tokens</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">

8
api-ref/src/docbkx/ch_identity-v2.xml
View File

@@ -24,11 +24,11 @@
<section xml:id="identity-api-extensions">
<title>Extensions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#extensions-v2">
<wadl:method href="#listExtensions-v2"/>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#identity-extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#extension-v2">
<wadl:method href="#showExtension-v2"/>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#extension">
<wadl:method href="#showExtension"/>
</wadl:resource>
</wadl:resources>
</section>

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

@@ -717,6 +717,20 @@
</para>
</wadl:doc>
</param>'>
<!-- x-openstack-request-id -->
<!ENTITY x-openstack-request-idResponseHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="x-openstack-request-id" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
A unique request ID that provides tracking for the request. Provider
must configure middleware to return a request ID header in a
response.
</para>
</wadl:doc>
</param>'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY COPY '<command xmlns="http://docbook.org/ns/docbook">COPY</command>'>

13
api-ref/src/wadls/identity-api/src/v2.0/common.ent
View File

@@ -137,6 +137,19 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY aliasTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
An alias for the extension name.
For example, <code>os-server-external-events</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY serviceIdQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="HP-IDM-serviceId" style="query"
type="xsd:string" required="false">

8
api-ref/src/wadls/identity-api/src/v2.0/samples/admin/extension-show-response.json
View File

@@ -1,7 +1,7 @@
{
"extension": {
"updated": "2013-07-07T12:00:0-00:00",
"name": "OpenStack S3 API",
"name": "OpenStack OAUTH1 API",
"links": [
{
"href": "https://github.com/openstack/identity-api",
@@ -9,8 +9,8 @@
"rel": "describedby"
}
],
"namespace": "http://docs.openstack.org/identity/api/ext/s3tokens/v1.0",
"alias": "s3tokens",
"description": "OpenStack S3 API."
"namespace": "http://docs.openstack.org/identity/api/ext/OS-OAUTH1/v1.0",
"alias": "OS-OAUTH1",
"description": "OpenStack OAuth 1.0a Delegated Auth Mechanism."
}
}

28
api-ref/src/wadls/identity-api/src/v2.0/samples/admin/extensions-list-response.json
View File

@@ -29,6 +29,20 @@
"alias": "OS-EP-FILTER",
"description": "OpenStack Keystone Endpoint Filter API."
},
{
"updated": "2014-02-24T20:51:0-00:00",
"name": "OpenStack Revoke API",
"links": [
{
"href": "https://github.com/openstack/identity-api/blob/master/openstack-identity-api/v3/src/markdown/identity-api-v3-os-revoke-ext.md",
"type": "text/html",
"rel": "describedby"
}
],
"namespace": "http://docs.openstack.org/identity/api/ext/OS-REVOKE/v1.0",
"alias": "OS-REVOKE",
"description": "OpenStack revoked token reporting mechanism."
},
{
"updated": "2013-12-17T12:00:0-00:00",
"name": "OpenStack Federation APIs",
@@ -71,6 +85,20 @@
"alias": "OS-SIMPLE-CERT",
"description": "OpenStack simple certificate retrieval extension"
},
{
"updated": "2013-07-07T12:00:0-00:00",
"name": "OpenStack OAUTH1 API",
"links": [
{
"href": "https://github.com/openstack/identity-api",
"type": "text/html",
"rel": "describedby"
}
],
"namespace": "http://docs.openstack.org/identity/api/ext/OS-OAUTH1/v1.0",
"alias": "OS-OAUTH1",
"description": "OpenStack OAuth 1.0a Delegated Auth Mechanism."
},
{
"updated": "2013-07-07T12:00:0-00:00",
"name": "OpenStack EC2 API",

34
api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
View File

@@ -30,7 +30,8 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="identity-admin-v2.0">
<resource id="version-admin-v2" path="//v2.0">
<resource id="admin-version" path="//v2.0">
<method href="#admin-getVersionInfo"/>
<resource id="admin-tokens" path="tokens">
<param xmlns="http://wadl.dev.java.net/2009/02" name="X-Auth-Token" style="header"
type="xsd:string" required="true">
@@ -233,9 +234,40 @@
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<method href="#admin-getVersionInfo"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Version -->
<method name="GET" id="admin-getVersionInfo">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get version details">
<para>
Gets detailed information about a version of the Identity API.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample title="Get version information: JSON response">
<xsdxt:code href="../samples/admin/version-show-response.json"/>
</xsdxt:sample>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="location" style="plain"
type="xsd:anyURI" required="true"
path="/capi:version/atom:link[@rel='self']/@href">
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>
</response>
<response status="203"/>
&commonFaults; &getFaults;
</method>
<!-- Token Operations -->
<method name="POST" id="admin-authenticate">
<wadl:doc xml:lang="EN" title="Authenticate for admin API"

67
api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl
View File

@@ -34,10 +34,11 @@
<method href="#listVersions-v2"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v2.0">
<resource id="extensions-v2" type="#ExtensionList" path="extensions">
<resource id="extension-v2.0" path="{alias}">
<resource id="identity-extensions" path="extensions">
<method href="#listExtensions"/>
<resource id="extension" path="{alias}">
&aliasTemplateParameter;
<method href="#showExtension-v2"/>
<method href="#showExtension"/>
</resource>
</resource>
<resource id="tokens" path="tokens">
@@ -64,15 +65,6 @@
<resource_type id="VersionDetails">
<method href="#showVersionInfo-v2.0"/>
</resource_type>
<resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN" title="List extensions">
<para role="shortdesc">
Lists supported extensions.
</para>
</wadl:doc>
<method href="#listExtensions-v2"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
@@ -112,7 +104,7 @@
<response status="203"/> &commonFaults; &getFaults;
</method>
<!-- Extensions -->
<method name="GET" id="listExtensions-v2">
<method name="GET" id="listExtensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="List extensions">
@@ -121,53 +113,34 @@
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json" element="capi:extensions">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:sample title="List extensions: JSON response">
<xsdxt:code href="../samples/admin/extensions-list-response.json"/>
</xsdxt:sample>
</wadl:doc>
<!-- <param xmlns="http://wadl.dev.java.net/2009/02"
name="next" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Moves to the next item in the list.
</para>
</wadl:doc>
<link resource_type="#ExtensionList" rel="next"/>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="previous" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Moves to the previous item in the list.
</para>
</wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param> -->
&x-openstack-request-idResponseHeader;
</representation>
</response>
<response status="203"/> &commonFaults; &getFaults;
</method>
<method name="GET" id="showExtension-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show extension details">
<para role="shortdesc">Shows details for an extension.</para>
<para>Specify the extension alias in the URI.</para>
<method name="GET" id="showExtension">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show extension details">
<para role="shortdesc">
Shows details for an extension, by alias.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json" element="capi:extension">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:sample title="Show extension details: JSON response">
<xsdxt:code href="../samples/admin/extension-show-response.json"/>
</xsdxt:sample>
</wadl:doc>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../samples/admin/extension-show-response.json"
/>
</wadl:doc> &x-openstack-request-idResponseHeader;
</representation>
</response>
<response status="203"/> &commonFaults; &getFaults;
<response status="203"/>
</method>
<!-- Token Operations -->
<method name="POST" id="authenticate-v2.0">