openstack/api-site
Code Issues Proposed changes

Merge "Remove limit and marker parameters from POST methods."

Browse Source
This commit is contained in:
Jenkins 2015-03-24 19:40:58 +00:00 committed by Gerrit Code Review
commit c369b56ab3
6 changed files with 94 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl
View File

@ -13,6 +13,7 @@
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
@ -59,7 +60,6 @@
xml:lang="EN"><para>The service
ID.</para></wadl:doc>
</param>
&limitMarkerReqParameter;
<method href="#listUserRoles"/>
<resource id="user-roles-OS-KSADM-v2.0"
path="OS-KSADM">
@ -93,7 +93,6 @@
<method href="#updateTenant"/>
<method href="#deleteTenant"/>
<resource id="usersForTenant-v2.0" path="users">
&limitMarkerReqParameter;
<method href="#listUsersForTenant"/>
<resource id="userForTenant-v2.0"
path="{userId}">
@ -165,7 +164,6 @@
</resource>
</resource>
<resource id="services-v2.0" path="services">
&limitMarkerReqParameter;
<method href="#listServices"/>
<method href="#addService"/>
<resource id="serviceName-v2.0">
@ -201,7 +199,7 @@
<!-- Tenant Operations -->
<method name="POST" id="addTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Tenant">
title="Add tenant">
<para role="shortdesc">Creates a tenant.</para>
</wadl:doc>
<request>
@ -242,7 +240,7 @@
</response> &commonFaults; &postPutFaults; </method>
<method name="POST" id="updateTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update Tenant">
title="Update tenant">
<para role="shortdesc"> Updates a tenant.</para>
</wadl:doc>
<request>
@ -281,16 +279,19 @@
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method name="DELETE" id="deleteTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Tenant">
title="Delete tenant">
<para role="shortdesc"> Deletes a tenant.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>
<method name="GET" id="listUsersForTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Users for a Tenant">
title="List users for a tenant">
<para role="shortdesc">Lists all users for a
tenant.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:users">
@ -309,7 +310,7 @@
</response> &commonFaults; &getFaults; </method>
<method name="PUT" id="addRolesToUserOnTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Roles to User on Tenant">
title="Add roles to user on tenant">
<para role="shortdesc">Adds a specified role to a user for
a tenant.</para>
</wadl:doc>
@ -317,7 +318,7 @@
&getFaults; </method>
<method name="DELETE" id="deleteRoleFromUserOnTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Roles from User on Tenant">
title="Delete roles from user on tenant">
<para role="shortdesc">Deletes a specified role from a
user on a tenant.</para>
</wadl:doc>
@ -325,9 +326,12 @@
<!-- User Operations -->
<method name="GET" id="listUsers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Users">
title="List users">
<para role="shortdesc">Lists users.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:userss">
@ -345,7 +349,7 @@
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="POST" id="addUser">
<wadl:doc xml:lang="EN" title="Add User"
<wadl:doc xml:lang="EN" title="Add user"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Adds a user.</para>
</wadl:doc>
@ -389,7 +393,7 @@
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method name="PUT" id="updateUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update User">
title="Update user">
<para role="shortdesc">Updates a user.</para>
</wadl:doc>
<request>
@ -424,12 +428,12 @@
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="DELETE" id="deleteUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete User">
title="Delete user">
<para role="shortdesc">Deletes a user.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>
<method name="PUT" id="setUserEnabled">
<wadl:doc xml:lang="EN" title="Enable User"
<wadl:doc xml:lang="EN" title="Enable user"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Enables a specified user.</para>
<table rules="all">
@ -494,6 +498,9 @@
<para role="shortdesc">Lists global roles for a specified
user.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -524,7 +531,7 @@
<method name="DELETE" id="deleteUserRole">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Global Role from User">
title="Delete global role from user">
<para role="shortdesc">Deletes a specific global role from
a user.</para>
</wadl:doc>
@ -532,11 +539,13 @@
<!-- Roles -->
<method name="GET" id="listRoles">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Roles">
title="List roles">
<para role="shortdesc">Lists roles.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:roles">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -566,7 +575,7 @@
<method name="POST" id="addRole">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Role">
title="Add role">
<para role="shortdesc">Adds a role.</para>
</wadl:doc>
<request>
@ -658,7 +667,7 @@
<method name="DELETE" id="deleteRole">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Role">
title="Delete role">
<para role="shortdesc">Deletes a role.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>
@ -666,10 +675,12 @@
<!-- Service Operations -->
<method name="GET" id="listServices">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Services">
title="List services">
<para role="shortdesc">Lists services.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="services">
@ -689,7 +700,7 @@
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getServiceByName">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get Service by Name">
title="Get service by name">
<para role="shortdesc">Gets a service by name.</para>
</wadl:doc>
@ -712,7 +723,7 @@
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get Service">
title="Get service">
<para role="shortdesc">Gets a service.</para>
</wadl:doc>
<response status="200 203">
@ -734,7 +745,7 @@
</response> &commonFaults; &getFaults; </method>
<method name="POST" id="addService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Service">
title="Add service">
<para role="shortdesc">Adds a service.</para>
</wadl:doc>
<request>
@ -778,7 +789,7 @@
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="DELETE" id="deleteService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Service">
title="Delete service">
<para role="shortdesc">Deletes a service.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>

8
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl
View File

@ -10,6 +10,8 @@
<!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"
@ -121,6 +123,9 @@
title="List endpoint templates">
<para role="shortdesc">Lists endpoint templates.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="endpointTemplates">
@ -320,6 +325,9 @@
<para role="shortdesc">Lists endpoints for a
tenant.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:endpoints">

19
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl
View File

@ -54,7 +54,6 @@
<resource id="user-OS-KSADM" path="OS-KSADM">
<resource id="userCredentials"
path="credentials">
&limitMarkerReqParameter;
<method href="#listCredentials"/>
<method href="#addUserCredential"/>
<resource id="userCredentialsByType"
@ -88,7 +87,7 @@
<!-- User Credentials-->
<method name="POST" id="addUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add User Credentials">
title="Add user credentials">
<para role="shortdesc">Adds a credential to a user.</para>
</wadl:doc>
<request>
@ -132,9 +131,12 @@
<method name="GET" id="listCredentials">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Credentials">
title="List credentials">
<para role="shortdesc">Lists credentials.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">
@ -157,9 +159,12 @@
<method name="GET" id="listCredentialsByType">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Credentials by Type">
title="List credentials by type">
<para role="shortdesc">Lists credentials by type.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">
@ -180,7 +185,7 @@
<method name="POST" id="updateUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update User Credentials">
title="Update user credentials">
<para role="shortdesc">Updates credentials for a specified
user.</para>
</wadl:doc>
@ -225,7 +230,7 @@
<method name="DELETE" id="deleteUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete User Credentials">
title="Delete user credentials">
<para role="shortdesc">Deletes user credentials.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &postPutFaults;
@ -233,7 +238,7 @@
<method name="GET" id="getUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get User Credentials">
title="Get user credentials">
<para role="shortdesc">Gets user credentials.</para>
</wadl:doc>
<response status="200 203">

7
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl
View File

@ -53,7 +53,6 @@
<resource id="user-OS-OS-KSS3" path="OS-OS-KSS3">
<resource id="userCredentials"
path="credentials">
&limitMarkerReqParameter;
<method href="#listCredentials"/>
<method href="#addUserCredential"/>
<resource id="userCredentialsByType"
@ -130,6 +129,9 @@
title="List credentials">
<para role="shortdesc">Lists credentials.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">
@ -156,6 +158,9 @@
<para role="shortdesc" class="shortdesc">Lists credentials
by type.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">

8
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl
View File

@ -9,7 +9,10 @@
<!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:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
@ -171,10 +174,13 @@
<response status="200 203"/> &commonFaults; &getFaults; </method>
<method name="GET" id="listEndpointsForToken">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List endpoints for a token">
title="List endpoints for token">
<para role="shortdesc">Lists endpoints associated with a
specific token.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:endpoints">

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

@ -12,6 +12,7 @@
<!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"
@ -75,10 +76,13 @@
<param xmlns="http://wadl.dev.java.net/2009/02" name="belongsTo" style="query"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Validates that a token has the specified tenant in scope, for
performance. Valid tokens are in the <code>/tokens/{tokenId}</code>
path. An itemNotFound (<code>404</code>) fault is returned for a
token that is not valid.</para>
<para>
Validates that a token has the specified
tenant in scope, for performance. Valid tokens
are in the <code>/tokens/{tokenId}</code>
path. An itemNotFound (<code>404</code>) fault
is returned for a token that is not valid.
</para>
</wadl:doc>
</param>
<method href="#admin-validateToken"/>
@ -120,7 +124,6 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A valid
authentication token for an administrative user.</wadl:doc>
</param>
&limitMarkerReqParameter;
<method href="#admin-listTenants"/>
<method href="#admin-getTenantByName"/>
<resource id="admin-tenantById" path="{tenantId}">
@ -248,7 +251,7 @@
</response> &commonFaults; &getFaults; </method>
<!-- Token Operations -->
<method name="POST" id="admin-authenticate">
<wadl:doc xml:lang="EN" title="Authenticate for Admin API"
<wadl:doc xml:lang="EN" title="Authenticate for admin API"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Authenticates and generates a token.</para>
<para>Client authentication is provided through a ReST interface by using the POST
@ -488,6 +491,9 @@
title="List endoints for token">
<para role="shortdesc">Lists the endpoints associated with a specified token.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@ -700,6 +706,9 @@
<para role="shortdesc">Lists global roles for a specified user. Excludes tenant
roles.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@ -729,6 +738,9 @@
</xsdxt:sample>
</xsdxt:samples>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@ -802,6 +814,9 @@
<para role="shortdesc">Lists roles for a specified user on a specified tenant. Excludes
global roles.</para>
</wadl:doc>
<request>
&limitMarkerReqParameter;
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">