openstack/barbican
Code Issues Proposed changes

Replace 'tenants' for 'projects' in documentation

Browse Source 
Partially implements: blueprint replace-concept-of-tenants-for-projects

Change-Id: I54f36c5a19488c4af5dfa67550b3d822922b4bb9
This commit is contained in:
Juan Antonio Osorio Robles
2014-12-10 15:39:37 +02:00
parent f29d08610d
commit 347a325833
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/docbkx/ck-devguide.xml
View File

@@ -150,9 +150,9 @@
token, you must supply a payload of credentials in the
authentication request.</para>
<para>Credentials are usually a combination of your user name
and password, and optionally, the name or ID of the tenant in
and password, and optionally, the name or ID of the project in
which your cloud runs. Ask your cloud administrator for your
user name, password, and tenant so that you can generate
user name, password, and project so that you can generate
authentication tokens. </para>
<para>When you send API requests, you include the token in the
<code>X-Auth-Token</code> HTTP header. If you access

8
docs/src/docbkx/ck-gettingstarted.xml
View File

@@ -347,8 +347,8 @@
authentication token, you must supply a payload of
credentials in the authentication request.</para>
<para>Credentials are usually a combination of your user name and password, and optionally,
the name or ID of the tenant in which your cloud runs. Ask your cloud administrator for
your user name, password, and tenant so that you can generate authentication tokens. </para>
the name or ID of the project in which your cloud runs. Ask your cloud administrator for
your user name, password, and project so that you can generate authentication tokens. </para>
<para>When you send API requests, you include the token in the
X-Auth-Token header. If you access multiple OpenStack
services, you must get a token for each service. A token
@@ -641,7 +641,7 @@
<section xml:id="Retrieve_multiple_secrets">
<title>Retrieving a list of stored secrets</title>
<para>You can retrieve a list of secrets that are
associated with a given tenant by typing the following
associated with a given project by typing the following
command:</para>
<para>
<programlisting>curl -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'X-Project-Id:12345' https://<replaceable>endpointURL</replaceable>/v1/secrets</programlisting>
@@ -701,7 +701,7 @@
<title>Retrieving a list of orders</title>
<para>You can use a single <command>GET</command> request
to retrieve metadata for multiple orders for a given
tenant. To do so, type the following command:</para>
project. To do so, type the following command:</para>
<para>
<programlisting>curl -H 'Accept: application/json' -H 'X-Project-Id:12345' https://<replaceable>endpointURL</replaceable>/v1/orders </programlisting>
</para>

14
docs/src/wadl/Barbican.wadl
View File

@@ -23,7 +23,7 @@
<resource id="tenantid" path="/{tenantId}">
<param name="tenantId" type="xsd:string"
required="true" style="template">
<doc>This parameter specifies the tenant ID of the client
<doc>This parameter specifies the project ID of the client
subscribing to the Barbican service</doc>
</param>
<!-- SECRETS resource -->
@@ -68,8 +68,8 @@
<method name="GET" id="getSecrets">
<wadl:doc xml:lang="EN" title="Get Secrets"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">This method retrieves all secrets for a given tenant.</para>
<para>This method lists all the secrets for a tenant.</para>
<para role="shortdesc">This method retrieves all secrets for a given project.</para>
<para>This method lists all the secrets for a project.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@@ -81,7 +81,7 @@
<response status="200">
<doc title="Error">This status code is returned when the
secrets have been successfully retrieved for the
tenant. </doc>
project. </doc>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../wadl/samples/resgetSecrets.json"/>
@@ -306,7 +306,7 @@ The following values are supported:</para>
<response status="404">
<doc title="Error">This error code is returned when the
supplied UUID doesn't match the secret in the
datastore for the specified tenant.</doc>
datastore for the specified project.</doc>
</response>
<response status="400">
<doc title="Error">This error code is returned when no
@@ -339,8 +339,8 @@ The following values are supported:</para>
<method name="GET" id="getOrders">
<wadl:doc xml:lang="EN" title="Get Orders"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">This method retrieves all orders for a given tenant.</para>
<para>This method lists all orders for a specified tenant. Performing a GET on the secrets resource with no UUID retrieves a batch of the most recent orders per the requesting tenant.
<para role="shortdesc">This method retrieves all orders for a given project.</para>
<para>This method lists all orders for a specified project. Performing a GET on the secrets resource with no UUID retrieves a batch of the most recent orders per the requesting project.
The retrieved list of orders is ordered by oldest to newest created date. </para>
</wadl:doc>
<request>