diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index b458fdbd6..74a06fbdb 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -49,7 +49,7 @@ api-ref-blockstorage-v2 - + os-api-ref-blockstorage-v1 generate-pdf diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml index 7cedcb3dd..6e96ba815 100644 --- a/api-ref/src/docbkx/ch_identity-admin-v2.xml +++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml @@ -1,24 +1,35 @@ - + Identity admin API v2.0 (STABLE) - Get an authentication token that permits access to the - Compute API. - + Get an authentication token that permits access to the Compute API. + + + + + + + + + + + + + + + + + + + + + - - + href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#userRolesForTenant"> + + diff --git a/api-ref/src/docbkx/ch_identity-v3.xml b/api-ref/src/docbkx/ch_identity-v3.xml index c21f4bdfb..e310984a6 100644 --- a/api-ref/src/docbkx/ch_identity-v3.xml +++ b/api-ref/src/docbkx/ch_identity-v3.xml @@ -1,25 +1,19 @@ - + Identity API v3 (STABLE) - Get an authentication token that permits access to the - Compute API. + Get an authentication token that permits access to the Compute API.
API versions - + - + @@ -30,8 +24,7 @@ Manage tokens. - + @@ -45,8 +38,7 @@ Manage the catalog of services. - + @@ -64,58 +56,50 @@ Manage endpoints. + - + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoint_id"/>
Domains Manage domains. - Domains represent collections of users, groups, and - projects. Each is owned by exactly one domain. Users, - however, can be associated with multiple projects by - granting roles to the user on a project, including - projects owned by other domains. - Each domain defines a namespace where certain - API-visible name attributes exist, which affects whether - those names must be globally unique or unique within that - domain. In the Identity API, the uniqueness of the - following attributes is as follows: + Domains represent collections of users, groups, and projects. Each is owned by exactly + one domain. Users, however, can be associated with multiple projects by granting roles + to the user on a project, including projects owned by other domains. + Each domain defines a namespace where certain API-visible name attributes exist, which + affects whether those names must be globally unique or unique within that domain. In the + Identity API, the uniqueness of the following attributes is as follows: - Domain Name. - Globally unique across all domains. + Domain Name. Globally unique across all + domains. - Role Name. - Globally unique across all domains. + Role Name. Globally unique across all + domains. - User Name. - Unique within the owning domain. + User Name. Unique within the owning + domain. - Project Name. - Unique within the owning domain. + Project Name. Unique within the owning + domain. - Group Name. - Unique within the owning domain. + Group Name. Unique within the owning + domain. - + - + @@ -143,29 +127,29 @@
-
+ + - + - - - + -\-> + @@ -174,7 +158,7 @@ - + -
+ -->
Users @@ -191,18 +175,16 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#create-users"> - + - + + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user-roles"> + +
@@ -291,13 +274,11 @@ Manage policies. - + - + diff --git a/api-ref/src/docbkx/ch_netconn-ext-v2.xml b/api-ref/src/docbkx/ch_netconn-ext-v2.xml index 14f212803..67dcd5ab5 100644 --- a/api-ref/src/docbkx/ch_netconn-ext-v2.xml +++ b/api-ref/src/docbkx/ch_netconn-ext-v2.xml @@ -30,9 +30,6 @@ - - diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl index 131d58ca6..2a6b7a6a1 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl @@ -26,68 +26,54 @@ - + - + - - Required. The user - name. + + + Required. The user name. + - - Required. The password of the - user. + + + Required. The password of the user. + - - Optional. The tenant - name. + + + Optional. The tenant name. + - - Optional. The tenant - ID. + + + Optional. The tenant ID. + - - Required. The token - ID. + + Required. The + token ID. - - Validates that a token - has the specified tenant in scope, for - performance. Valid tokens are in the - /tokens/{tokenId} - path. An itemNotFound - (404) fault is - returned for a token that is not - valid. + + + Validates that a token has the specified tenant in scope, for + performance. Valid tokens are in the /tokens/{tokenId} + path. An itemNotFound (404) fault is returned for a + token that is not valid. + @@ -97,27 +83,21 @@ - - A valid authentication token for - an administrative user. + + A valid + authentication token for an administrative user. - - - The user name. + + + The user + name. - - The user ID. + + The user + ID. @@ -126,46 +106,34 @@ - - A valid authentication token for - an administrative user. + + A valid + authentication token for an administrative user. - - The ID of the last item in the - previous list. + + The ID of the last + item in the previous list. - - The page size. + + The page size. + - - The tenant ID. + + The tenant + ID. - - The user - ID. + + The + user ID. - - + + @@ -177,13 +145,11 @@ - - + A list of supported extensions. @@ -193,31 +159,23 @@ - - Gets detailed information about a specified version - of the Identity API. + + Gets detailed information about a specified version of the Identity API. - - - + - + - + - + - @@ -225,35 +183,27 @@ &commonFaults; &getFaults; - + Lists available extensions. - - - - - + + - Moves to the next item in the - list. + Moves to the next + item in the list. - Moves to the previous item in - the list. - + Moves to the + previous item in the list. + &commonFaults; &getFaults; - - Gets detailed information for a specified - extension. + + Gets detailed information for a specified extension. - + @@ -295,339 +242,230 @@ - Authenticates and generates a - token. - Client authentication is provided through a ReST - interface by using the POST method with v2.0/tokens - supplied as the path. Include a payload of credentials - in the body. - The Identity API is a ReSTful web service. It is the - entry point to all service APIs. To access the - Identity API, you must know its URL. - Each ReST request against the Identity Service - requires the X-Auth-Token header. Clients - obtain this token, along with the URL to other service - APIs, by first authenticating against Identity with - valid credentials. - If the authentication token has expired, a - 401 response code is - returned. - If the token specified in the request body has - expired, this call returns a + Authenticates and generates a token. + Client authentication is provided through a ReST interface by using the POST + method with v2.0/tokens supplied as the path. Include a payload of credentials in + the body. + The Identity API is a ReSTful web service. It is the entry point to all service + APIs. To access the Identity API, you must know its URL. + Each ReST request against the Identity Service requires the + X-Auth-Token header. Clients obtain this token, along with the URL + to other service APIs, by first authenticating against Identity with valid + credentials. + If the authentication token has expired, a 401 response + code is returned. + If the token specified in the request body has expired, this call returns a 404 response code. - Identity treats expired tokens as invalid - tokens. - The deployment determines how long expired tokens - are stored. + Identity treats expired tokens as invalid tokens. + The deployment determines how long expired tokens are stored. - - - + - - + + - + - - + + - - The tenant name. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are - specified, the server responds with a - 400 - Bad - Request. + + The tenant name. Both the + tenantId and tenantName attributes are + optional, but should not be specified together. If both attributes are + specified, the server responds with a 400 + Bad Request. - - The tenant ID. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are - specified, the server responds with a - 400 - Bad - Request. + + The tenant ID. Both the + tenantId and tenantName attributes are + optional, but should not be specified together. If both attributes are + specified, the server responds with a 400 + Bad Request. - - A passwordCredentials - object. To authenticate, you must provide - either a user ID and password or a + + A + passwordCredentials object. To authenticate, you must + provide either a user ID and password or a token. + + + The user name. Required if + you include the passwordCredentials object. If you do not + provide a password credentials, you must provide a + token. + + + The password of the user. + Required if you include the passwordCredentials object. If + you do not provide a password credentials, you must provide a token. - - The user name. Required if you - include the - passwordCredentials - object. If you do not provide a password - credentials, you must provide a - token. + + A token + object. Required if you do not provide password + credentials. - - The password of the user. Required - if you include the - passwordCredentials - object. If you do not provide a password - credentials, you must provide a - token. - - - A token object. - Required if you do not provide password - credentials. - - - The token ID. This is a required - field in the token - object. + + The token ID. This is a + required field in the token object. - + - - + + - + - - + + - - - - - + + - + - + - - An access + + An access object. - - A token - object. - - - A timestamp that indicates when the - token was issued. - - - A timestamp that indicates when the - token expires. - - - The authentication token. In the - example, the token is - my_id. - - - A tenant + + A token object. - - The description of the tenant. If - not set, this value is - null. + + A timestamp that indicates + when the token was issued. - - Indicates whether the tenant is - enabled or disabled. + + A timestamp that indicates + when the token expires. - - The tenant ID. + + The authentication token. + In the example, the token is my_id. - - The tenant name. - - - A serviceCatalog + + A tenant object. - - One or more endpoints - objects. Each object shows the - adminURL, - region, - internalURL, - id, and - publicURL for the + + The description of the + tenant. If not set, this value is null. + + + Indicates whether the + tenant is enabled or disabled. + + + The tenant + ID. + + + The tenant + name. + + + A + serviceCatalog object. + + + One or more + endpoints objects. Each object shows the + adminURL, region, + internalURL, id, and publicURL + for the endpoint. + + + Links for the endpoint. - - Links for the - endpoint. + + Endpoint + type. - - Endpoint type. + + Endpoint + name. - - Endpoint name. + + A user + object, which shows the username, roles_links, + id, roles, and + name. - - A user object, which - shows the username, - roles_links, - id, roles, - and name. - - - A metadata + + A metadata object. - + &commonFaults; &getFaults; - - Validates a token and confirms that - it belongs to a specified tenant. - Returns the permissions relevant to a particular - client. Valid tokens are in the - /tokens/{tokenId} path. A user should - expect an itemNotFound (404) fault for an - token that is not valid. + + Validates a token and confirms that it belongs to a specified + tenant. + Returns the permissions relevant to a particular client. Valid tokens are in the + /tokens/{tokenId} path. A user should expect an itemNotFound + (404) fault for an token that is not valid. - - + + - + - + &commonFaults; &getFaults; - - Validates a token and confirms that - it belongs to a specified tenant, for performance. - + + Validates a token and confirms that it belongs to a specified + tenant, for performance. &commonFaults; &getFaults; - Lists the endpoints associated with - a specified token. + Lists the endpoints associated with a specified token. - + - + - + @@ -639,8 +477,8 @@ - Gets detailed information about a - specified user by user name. + Gets detailed information about a specified user by user + name. - - + + - + @@ -666,44 +501,37 @@ - Gets detailed information about a - specified user by user ID. + Gets detailed information about a specified user by user + ID. - - + + - + &commonFaults; &getFaults; - - Lists global roles for a specified - user. Excludes tenant roles. + + Lists global roles for a specified user. Excludes tenant + roles. - + - + - + @@ -713,14 +541,12 @@ - + Lists all tenants. - + @@ -732,8 +558,7 @@ - + @@ -744,15 +569,13 @@ - Gets detailed information about a - specified tenant by name. + Gets detailed information about a specified tenant by + name. - - The name of the + + The name of the tenant. @@ -760,17 +583,14 @@ - + - + - + @@ -779,48 +599,40 @@ - Gets detailed information about a - specified tenant by ID. + Gets detailed information about a specified tenant by ID. - + - + - + &commonFaults; &getFaults; - - Lists roles for a specified user on - a specified tenant. Excludes global roles. + + Lists roles for a specified user on a specified tenant. Excludes + global roles. - + - + - + diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/common.ent b/api-ref/src/wadls/identity-api/src/v3/wadl/common.ent index d755ecaae..2ad951ab3 100644 --- a/api-ref/src/wadls/identity-api/src/v3/wadl/common.ent +++ b/api-ref/src/wadls/identity-api/src/v3/wadl/common.ent @@ -519,125 +519,154 @@ '> - - The interface type, which is admin, public, or internal. + + + The interface type, which is admin, public, or + internal. '> - + The date and time stamp for when the token was issued. '> - + A token object. '> - + The date and time stamp for when the token expires. '> - + The domain ID. '> - + The domain links. '> - + The domain name. '> - + The user ID. '> - + The user links. '> - + The user name. '> - + A service object. '> - + A services object. '> - + The service ID. '> - - + + The service name. '> - - + + The service type. '> - The - service links. + + + The service links. + '> - A domains object. + + + A domains object. + +'> + + + The domain description. + +'> + + + Set to true to enable the domain. Otherwise, set to false. + +'> + + + The domain name. + '> - - The domain description. - '> - - Set to true to enable the domain. - Otherwise, set to false. - '> - - The domain name. - '> GET'> PUT'> diff --git a/api-ref/src/wadls/netconn-api/src/metering-labels.wadl b/api-ref/src/wadls/netconn-api/src/metering-labels.wadl index ab232eb4b..bb51f9546 100644 --- a/api-ref/src/wadls/netconn-api/src/metering-labels.wadl +++ b/api-ref/src/wadls/netconn-api/src/metering-labels.wadl @@ -8,9 +8,9 @@ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:csapi="http://www.w3.org/2001/XMLSchema" xmlns:metering="http://docs.openstack.org/neutron/api/v2.0"> - + diff --git a/pom.xml b/pom.xml index 3e96f9d51..b4241495b 100644 --- a/pom.xml +++ b/pom.xml @@ -39,7 +39,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 2.0.4 + 2.1.1