Merge "Update version and versions responses for Identity v2.0 and v3"

This commit is contained in:
Jenkins 2015-05-01 01:14:43 +00:00 committed by Gerrit Code Review
commit 09e87de6cd
21 changed files with 94 additions and 427 deletions

View File

@ -6,16 +6,12 @@
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v2.0+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v2.0+xml"
}
],
"id": "v2.0",
"links": [
{
"href": "http://192.168.122.176:5000/v2.0/",
"href": "http://localhost:5000/v2.0/",
"rel": "self"
},
{

View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json" type="application/vnd.openstack.identity-v2.0+json" />
<media-type base="application/xml" type="application/vnd.openstack.identity-v2.0+xml" />
</media-types>
<links>
<link href="http://192.168.122.176:5000/v2.0/" rel="self" />
<link href="http://docs.openstack.org/" type="text/html" rel="describedby" />
</links>
<link href="http://192.168.122.176:5000/v2.0/" rel="self" />
<link href="http://docs.openstack.org/" type="text/html" rel="describedby" />
</version>

View File

@ -2,10 +2,10 @@
"versions": {
"values": [
{
"id": "v3.0",
"id": "v3.4",
"links": [
{
"href": "http://192.168.122.176:5000/v3/",
"href": "http://localhost:35357/v3/",
"rel": "self"
}
],
@ -13,20 +13,16 @@
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v3+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v3+xml"
}
],
"status": "stable",
"updated": "2013-03-06T00:00:00Z"
"updated": "2015-03-30T00:00:00Z"
},
{
"id": "v2.0",
"links": [
{
"href": "http://192.168.122.176:5000/v2.0/",
"href": "http://localhost:35357/v2.0/",
"rel": "self"
},
{
@ -39,10 +35,6 @@
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v2.0+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v2.0+xml"
}
],
"status": "stable",

View File

@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<versions xmlns="http://docs.openstack.org/identity/api/v2.0">
<version status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json" type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml" type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://192.168.122.176:5000/v3/" rel="self"/>
</links>
</version>
<version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json" type="application/vnd.openstack.identity-v2.0+json"/>
<media-type base="application/xml" type="application/vnd.openstack.identity-v2.0+xml"/>
</media-types>
<links>
<link href="http://192.168.122.176:5000/v2.0/" rel="self"/>
<link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
</links>
<link href="http://192.168.122.176:5000/v2.0/" rel="self"/>
<link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
</version>
</versions>

View File

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<title type="text">About This Version</title>
<updated>2011-01-21T11:33:21-06:00</updated>
<id>http://identity.api.openstack.org/v2.0/</id>
<author><name>OpenStack</name><uri>http://www.openstack.org/</uri></author>
<link rel="self" href="http://identity.api.openstack.org/v2.0/"/>
<entry>
<id>http://identity.api.openstack.org/v2.0/</id>
<title type="text">Version v2.0</title>
<updated>2011-01-21T11:33:21-06:00</updated>
<link rel="self" href="http://identity.api.openstack.org/v2.0/"/>
<link rel="describedby" type="application/pdf"
href="http://docs.openstack.org/identity/api/v2.0/identity-latest.pdf"/>
<link rel="describedby" type="application/vnd.sun.wadl+xml"
href="http://docs.openstack.org/identity/api/v2.0/application.wadl"/>
<content type="text">Version v2.0 CURRENT (2011-01-21T11:33:21-06:00)</content>
</entry>
</feed>

View File

@ -1,23 +1,24 @@
{
"version": {
"status": "stable",
"updated": "2013-03-06T00:00:00Z",
"updated": "2014-04-17T00:00:00Z",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v3+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v3+xml"
"type": "application/vnd.openstack.identity-v2.0+json"
}
],
"id": "v3.0",
"id": "v2.0",
"links": [
{
"href": "http://localhost:5000/v3/",
"href": "http://localhost:5000/v2.0/",
"rel": "self"
},
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
}
]
}
}
}

View File

@ -1,20 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://localhost:5000/v3/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/identity-dev-guide-3.pdf"
type="application/pdf" rel="describedby"/>
</links>
</version>

View File

@ -11,7 +11,7 @@
"id": "v2.0",
"links": [
{
"href": "http://localhost:35357/v2.0/",
"href": "http://localhost:5000/v2.0/",
"rel": "self"
},
{

View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json" type="application/vnd.openstack.identity-v2.0+json"/>
<media-type base="application/xml" type="application/vnd.openstack.identity-v2.0+xml"/>
</media-types>
<links>
<link href="http://localhost:35357/v2.0/" rel="self"/>
<link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
</links>
<link href="http://localhost:35357/v2.0/" rel="self"/>
<link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
</version>

View File

@ -1,29 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<title type="text">Available API Versions</title>
<updated>2010-12-12T18:30:02.25Z</updated>
<id>http://identity.api.openstack.org/</id>
<author><name>OpenStack</name><uri>http://www.openstack.org/</uri></author>
<link rel="self" href="http://identity.api.openstack.org/"/>
<entry>
<id>http://identity.api.openstack.org/v2.0/</id>
<title type="text">Version v2.0</title>
<updated>2011-05-27T20:22:02.25Z</updated>
<link rel="self" href="http://identity.api.openstack.org/v2.0/"/>
<content type="text">Version v2.1 CURRENT (2011-05-27T20:22:02.25Z)</content>
</entry>
<entry>
<id>http://identity.api.openstack.org/v1.1/</id>
<title type="text">Version v1.1</title>
<updated>2010-12-12T18:30:02.25Z</updated>
<link rel="self" href="http://identity.api.openstack.org/v1.1/"/>
<content type="text">Version v1.1 CURRENT (2010-12-12T18:30:02.25Z)</content>
</entry>
<entry>
<id>http://identity.api.openstack.org/v1.0/</id>
<title type="text">Version v1.0</title>
<updated>2009-10-09T11:30:00Z</updated>
<link rel="self" href="http://identity.api.openstack.org/v1.0/"/>
<content type="text">Version v1.0 DEPRECATED (2009-10-09T11:30:00Z)</content>
</entry>
</feed>

View File

@ -1,38 +0,0 @@
{
"versions": [
{
"id": "v1.0",
"status": "DEPRECATED",
"updated": "2009-10-09T11:30:00Z",
"links": [
{
"rel": "self",
"href": "http://identity.api.openstack.org/v1.0/"
}
]
},
{
"id": "v1.1",
"status": "CURRENT",
"updated": "2010-12-12T18:30:02.25Z",
"links": [
{
"rel": "self",
"href": "http://identity.api.openstack.org/v1.1/"
}
]
},
{
"id": "v2.0",
"status": "BETA",
"updated": "2011-05-27T20:22:02.25Z",
"links": [
{
"rel": "self",
"href": "http://identity.api.openstack.org/v2.0/"
}
]
}
],
"versions_links": []
}

View File

@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<versions xmlns="http://docs.openstack.org/common/api/v1.0"
xmlns:atom="http://www.w3.org/2005/Atom">
<version id="v1.0" status="DEPRECATED"
updated="2009-10-09T11:30:00Z">
<atom:link rel="self"
href="http://identity.api.openstack.org/v1.0/"/>
</version>
<version id="v1.1" status="CURRENT"
updated="2010-12-12T18:30:02.25Z">
<atom:link rel="self"
href="http://identity.api.openstack.org/v1.1/"/>
</version>
<version id="v2.0" status="BETA"
updated="2011-05-27T20:22:02.25Z">
<atom:link rel="self"
href="http://identity.api.openstack.org/v2.0/"/>
</version>
</versions>

View File

@ -12,7 +12,6 @@
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
@ -177,13 +176,6 @@
<xsdxt:code href="../samples/version.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml" element="capi:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample title="Get version information: XML response">
<xsdxt:code href="../samples/version.xml"/>
</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">

View File

@ -82,11 +82,6 @@
<xsdxt:code href="../samples/identity-versions-response.json"/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/identity-versions-response.xml"/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getVersionInfo-v2.0">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show version details">
@ -100,13 +95,6 @@
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml" element="capi:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample title="Get version information: XML response">
<xsdxt:code href="../samples/identity-version-response.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<!-- Extensions -->
<method name="GET" id="listExtensions-v2.0">

View File

@ -1,23 +1,19 @@
{
"version": {
"status": "stable",
"updated": "2013-03-06T00:00:00Z",
"id": "v3.4",
"links": [
{
"href": "http://localhost:35357/v3/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v3+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v3+xml"
}
],
"id": "v3.0",
"links": [
{
"href": "http://23.253.228.211:35357/v3/",
"rel": "self"
}
]
"status": "stable",
"updated": "2015-03-30T00:00:00Z"
}
}
}

View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:35357/v3/" rel="self"/>
</links>
</version>

View File

@ -1,23 +0,0 @@
{
"version": {
"status": "stable",
"updated": "2013-03-06T00:00:00Z",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v3+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v3+xml"
}
],
"id": "v3.0",
"links": [
{
"href": "http://localhost:5000/v3/",
"rel": "self"
}
]
}
}

View File

@ -1,20 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://localhost:5000/v3/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/identity-dev-guide-3.pdf"
type="application/pdf" rel="describedby"/>
</links>
</version>

View File

@ -450,14 +450,6 @@
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/identity-versions-response.xml"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="showVersionDetails-identity-v3">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -474,16 +466,7 @@
/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="../samples/identity-version-resp.xml"
/>
</xsdxt:sample>
</wadl:doc>&versionParam; &statusParam; &updatedParam;
&versionParam; &statusParam; &updatedParam;
&media-typesParam; &version-idParam;
&version-linksParam; </representation>
</response>
@ -495,48 +478,54 @@
xml:lang="EN" title="Authenticate">
<para role="shortdesc">Authenticates and generates a
token.</para>
<para>Returns a token, if successful. Each REST request
requires the inclusion of a specific authorization
token HTTP x-header, defined as
<code>X-Auth-Token</code>. Clients obtain
<code>X-Auth-Token</code> and the URL endpoints
for other service APIs by supplying their valid
credentials to the authentication service.</para>
<para>A REST interface provides client authentication by
using the POST method, with <code>auth/tokens</code>
supplied as the path. The body of the request must
include a payload of credentials including the
authentication method and, optionally, the
authorization scope. The scope includes either a
project or domain. If you include both project and
domain, an <code>HTTP 400 Bad Request</code> results,
because a token cannot be simultaneously scoped as
both a project and domain.</para>
<para>
Returns a token, if successful. Each REST request requires the
inclusion of a specific authorization token HTTP x-header,
defined as <code>X-Auth-Token</code>. Clients obtain <code>X
-Auth-Token</code> and the URL endpoints for other service
APIs by supplying their valid credentials to the
authentication service.
</para>
<para>
A REST interface provides client authentication by using the
POST method, with <code>auth/tokens</code> supplied as the
path. The body of the request must include a payload of
credentials including the authentication method and,
optionally, the authorization scope. The scope includes either
a project or domain. If you include both project and domain,
an <code>HTTP 400 Bad Request</code> results, because a token
cannot be simultaneously scoped as both a project and domain.
</para>
<important>
<para>If you do not include the optional scope and the
authenticating user has a defined default project
(the <code>default_project_id</code> attribute for
the user), that default project is treated as the
preferred authorization scope.</para>
<para>If no default project is defined, the token is
issued without an explicit scope of
authorization.</para>
<para>
If you do not include the optional scope and the
authenticating user has a defined default project (the
<code>default_project_id</code> attribute for the user),
that default project is treated as the preferred
authorization scope.
</para>
<para>
If no default project is defined, the token is issued
without an explicit scope of authorization.
</para>
</important>
<para>Provide one of the following sets of credentials to
authenticate: User ID and password, user name and
password scoped by domain ID or name, user ID and
password scoped by project ID or name with or without
domain scope, or token.</para>
<para>
Provide one of the following sets of credentials to
authenticate: User ID and password, user name and password
scoped by domain ID or name, user ID and password scoped by
project ID or name with or without domain scope, or token.
\
</para>
<para>The following examples demonstrate authentication
requests with different types of credentials.</para>
<note>
<para>If <code>scope</code> is included, <code>project
id</code> uniquely identifies the
<code>project</code>. However, <code>project
name</code> uniquely identifies the
<code>project</code> only when used in
conjunction with a <code>domain ID</code> or a
<code>domain name</code>.</para>
<para>
If <code>scope</code> is included, <code>project id</code>
uniquely identifies the <code>project</code>. However,
<code>project name</code> uniquely identifies the
<code>project</code> only when used in conjunction with a
<code>domain ID</code> or a <code>domain name</code>.
</para>
</note>
<para>If the authentication token has expired, a
<errorcode>401</errorcode> response code is

View File

@ -2,57 +2,44 @@
"versions": {
"values": [
{
"status": "stable",
"updated": "2013-03-06T00:00:00Z",
"id": "v3.4",
"links": [
{
"href": "http://localhost:35357/v3/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v3+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v3+xml"
}
],
"id": "v3.0",
"links": [
{
"href": "http://23.253.228.211:5000/v3/",
"rel": "self"
}
]
"status": "stable",
"updated": "2015-03-30T00:00:00Z"
},
{
"status": "stable",
"updated": "2014-04-17T00:00:00Z",
"id": "v2.0",
"links": [
{
"href": "http://localhost:35357/v2.0/",
"rel": "self"
},
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.identity-v2.0+json"
},
{
"base": "application/xml",
"type": "application/vnd.openstack.identity-v2.0+xml"
}
],
"id": "v2.0",
"links": [
{
"href": "http://23.253.228.211:5000/v2.0/",
"rel": "self"
},
{
"href": "http://docs.openstack.org/api/openstack-identity-service/2.0/content/",
"type": "text/html",
"rel": "describedby"
},
{
"href": "http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf",
"type": "application/pdf",
"rel": "describedby"
}
]
"status": "stable",
"updated": "2014-04-17T00:00:00Z"
}
]
}
}
}

View File

@ -1,38 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<versions xmlns="http://docs.openstack.org/identity/api/v2.0">
<version status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:5000/v3/" rel="self"/>
</links>
</version>
<version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v2.0+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v2.0+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</version>
</versions>