Merge "Fix the bug of "Lack of description of a parameter""
This commit is contained in:
Jenkins
Gerrit Code Review
commit
704de8c9dc
@ -58,18 +58,19 @@
|
|||||||
required="false" type="xsd:string">
|
required="false" type="xsd:string">
|
||||||
<wadl:doc
|
<wadl:doc
|
||||||
xmlns="http://docbook.org/ns/docbook"
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN"><para>Validates that a
|
xml:lang="EN">
|
||||||
token has the specified tenant in
|
<para>
|
||||||
scope, for performance. Valid
|
Validates that a token has the specified
|
||||||
tokens are in the
|
tenant in scope, for performance. Valid
|
||||||
<code>/tokens/{tokenId}</code>
|
tokens are in the
|
||||||
path. An itemNotFound
|
<code>/tokens/{tokenId}</code> path. If
|
||||||
(<code>404</code>) fault is
|
the token is not valid, this call throws
|
||||||
returned for a token that is not
|
the <code> itemNotFound (404)</code>
|
||||||
valid.</para></wadl:doc>
|
fault.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
<param name="HP-IDM-serviceId" style="query"
|
&serviceIdQueryParameter;
|
||||||
type="xsd:string" required="false"/>
|
|
||||||
<method href="#validateToken"/>
|
<method href="#validateToken"/>
|
||||||
<method href="#checkToken"/>
|
<method href="#checkToken"/>
|
||||||
</resource>
|
</resource>
|
||||||
@ -91,18 +92,7 @@
|
|||||||
authentication
|
authentication
|
||||||
token.</para></wadl:doc>
|
token.</para></wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
<param name="HP-IDM-serviceId" style="query"
|
&serviceIdQueryParameter;
|
||||||
type="xsd:string" required="false">
|
|
||||||
<wadl:doc
|
|
||||||
xmlns="http://docbook.org/ns/docbook"
|
|
||||||
xml:lang="EN"><para>A comma-separated
|
|
||||||
string of service IDs. Checks the
|
|
||||||
roles against the specified service
|
|
||||||
IDs. If a service ID is not valid
|
|
||||||
or if no roles are associated with
|
|
||||||
a service ID, a 401 fault is
|
|
||||||
returned.</para></wadl:doc>
|
|
||||||
</param>
|
|
||||||
<method href="#listEndpointsForToken"/>
|
<method href="#listEndpointsForToken"/>
|
||||||
</resource>
|
</resource>
|
||||||
</resource>
|
</resource>
|
||||||
@ -118,21 +108,24 @@
|
|||||||
<method name="GET" id="validateToken">
|
<method name="GET" id="validateToken">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
title="Validate token">
|
title="Validate token">
|
||||||
<para role="shortdesc">Checks that a token is valid and
|
<para role="shortdesc">
|
||||||
that it belongs to a specified tenant and service IDs.
|
Checks that a token is valid and that it belongs to a
|
||||||
Returns the permissions for a particular
|
specified tenant and any specified service IDs. Returns the
|
||||||
client.</para>
|
permissions for a particular client.
|
||||||
<para>Behavior is similar to
|
</para>
|
||||||
<code>/tokens/{tokenId}</code>. An itemNotFound
|
<para>
|
||||||
(<code>404</code>) fault is returned for a token
|
Behavior is similar to <code>/tokens/{tokenId}</code>. If the
|
||||||
that is not valid.</para>
|
token is not valid, the call throws the <code>itemNotFound
|
||||||
<para>This extension might decrypt
|
(404)</code> fault.
|
||||||
<code>X-Subject-Token</code> header and internally
|
</para>
|
||||||
call the normal validation for Identity, passing in
|
<para>
|
||||||
all headers and query parameters. It should therefore
|
This extension might decrypt the <code>X-Subject-Token</code>
|
||||||
support all existing calls on
|
header and internally call and pass in all headers and query
|
||||||
<code>/tokens/{tokenId}</code>, including
|
parameters to the normal validation code for Identity.
|
||||||
extensions such as HP-IDM.</para>
|
Consequently, this extension must support all existing
|
||||||
|
<code>/tokens/{tokenId}</code> calls including extensions such
|
||||||
|
as HP-IDM.
|
||||||
|
</para>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<response status="200 203">
|
<response status="200 203">
|
||||||
<representation mediaType="application/json" element="identity:access">
|
<representation mediaType="application/json" element="identity:access">
|
||||||
@ -147,27 +140,30 @@
|
|||||||
<method name="HEAD" id="checkToken">
|
<method name="HEAD" id="checkToken">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
title="Check token">
|
title="Check token">
|
||||||
<para role="shortdesc">Checks that a token is valid and
|
<para role="shortdesc">
|
||||||
that it belongs to a specified tenant and service IDs,
|
Checks that a token is valid and that it belongs to a
|
||||||
for performance.</para>
|
specified tenant and any specified service IDs, for performance.
|
||||||
<para>Behavior is similar to
|
</para>
|
||||||
<code>/tokens/{tokenId}</code>. An itemNotFound
|
<para>
|
||||||
(<code>404</code>) fault is returned for a token
|
Behavior is similar to <code>/tokens/{tokenId}</code>. If the
|
||||||
that is not valid.</para>
|
token is not valid, the call throws the <code>itemNotFound
|
||||||
<para>This extension might decrypt
|
(404)</code> fault.
|
||||||
<code>X-Subject-Token</code> header and internally
|
</para>
|
||||||
call the normal validation for Identity, passing in
|
<para>
|
||||||
all headers and query parameters. It should therefore
|
This extension might decrypt the <code>X-Subject-Token</code>
|
||||||
support all existing calls on
|
header and internally call and pass in all headers and query
|
||||||
<code>/tokens/{tokenId}</code>, including
|
parameters to the normal validation code for Identity.
|
||||||
extensions such as HP-IDM.</para>
|
Consequently, this extension must support all existing
|
||||||
|
<code>/tokens/{tokenId}</code> calls including extensions such
|
||||||
|
as HP-IDM.
|
||||||
|
</para>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<response status="200 203"/> &commonFaults; &getFaults; </method>
|
<response status="200 203"/> &commonFaults; &getFaults; </method>
|
||||||
<method name="GET" id="listEndpointsForToken">
|
<method name="GET" id="listEndpointsForToken">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
title="List endpoints for token">
|
title="List endpoints for token">
|
||||||
<para role="shortdesc">Lists endpoints associated with a
|
<para role="shortdesc">Lists endpoints associated with a
|
||||||
specific token.</para>
|
specified token.</para>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<request>
|
<request>
|
||||||
&limitMarkerReqParameter;
|
&limitMarkerReqParameter;
|
||||||
|
|||||||
@ -79,15 +79,67 @@
|
|||||||
<wadl:doc
|
<wadl:doc
|
||||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
xmlns="http://docbook.org/ns/docbook"
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN"><para>The role
|
xml:lang="EN">
|
||||||
description.</para></wadl:doc>
|
<para>
|
||||||
|
The role description.
|
||||||
|
</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">
|
||||||
|
<wadl:doc
|
||||||
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN">
|
||||||
|
<para>
|
||||||
|
One or more service IDs. Specify multiple values as a comma-separated
|
||||||
|
list. The API checks roles against the specified service IDs. If a
|
||||||
|
service ID is not valid or no roles are associated with it, this call
|
||||||
|
throws the <code>unauthorized (401)</code> fault.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
</param>'>
|
</param>'>
|
||||||
<!-- Authenticate Parameters -->
|
<!-- Authenticate Parameters -->
|
||||||
<!ENTITY authParameters
|
<!ENTITY authParameters '
|
||||||
'
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="username" style="plain" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The user name.</p></doc></param>
|
name="username" style="plain" required="true" type="xsd:string">
|
||||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="password" style="plain" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The password of the user.</p></doc></param>
|
<wadl:doc
|
||||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenantName" style="plain" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The tenant name.</p></doc></param>
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenantId" style="plain" required="false" type="capi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">The tenant ID.</p></doc></param>
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
'>
|
xml:lang="EN">
|
||||||
|
<para>
|
||||||
|
The user name.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||||
|
name="password" style="plain" required="true" type="xsd:string">
|
||||||
|
<wadl:doc
|
||||||
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN">
|
||||||
|
<para>The password of the user.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||||
|
name="tenantName" style="plain" required="false" type="xsd:string">
|
||||||
|
<wadl:doc
|
||||||
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN">
|
||||||
|
<para>The tenant name.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||||
|
name="tenantId" style="plain" required="false" type="capi:UUID">
|
||||||
|
<wadl:doc
|
||||||
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN">
|
||||||
|
<para>The tenant ID.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>'>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user