diff --git a/v3/src/markdown/identity-api-v3.md b/v3/src/markdown/identity-api-v3.md index 6b82b265..987115d5 100644 --- a/v3/src/markdown/identity-api-v3.md +++ b/v3/src/markdown/identity-api-v3.md @@ -20,6 +20,7 @@ These features are not yet considered stable (expected September 4th, 2014). - Introduced support for JSON Home. - Introduced a standard call to retrieve possible project and domain scope targets for a token. +- Addition of `url` optional attribute for ``regions``. What's New in Version 3.2 ------------------------- @@ -855,6 +856,10 @@ Optional attributes: If the region is hierarchically a child of another region, this field shall be set to the id of the parent region. +- `url` (string) + + *New in version 3.3* A URL field for the deployer to associate with a region. + Example entity: { @@ -864,7 +869,8 @@ Example entity: "links": { "self": "https://identity:35357/v3/regions/us-east-2" }, - "parent_region_id": "us-east" + "parent_region_id": "us-east", + "url": "http://example.com/auth" } } @@ -2039,7 +2045,8 @@ Response: "self": "https://identity:35357/v3/regions/us-east", "child_regions": "https://identity:35357/v3/regions?parent_region_id=us-east" }, - "parent_region_id": "us-east-coast" + "parent_region_id": "us-east-coast", + "url": "http://example.com/auth" }, ... ], @@ -2066,7 +2073,8 @@ Response: "self": "https://identity:35357/v3/regions/us-southwest", "child_regions": "http://identity:35357/v3/regions?parent_region_id=us-southwest" }, - "parent_region_id": "us-west-coast" + "parent_region_id": "us-west-coast", + "url": "http://example.com/auth" } } @@ -2079,7 +2087,8 @@ Request: { "region": { "description": "US West Subregion 1", - "parent_region_id": "829551" + "parent_region_id": "829551", + "url": "http://example.com/auth" } } @@ -2095,7 +2104,8 @@ Response: "self": "https://identity:35357/v3/regions/8ebd7f", "child_regions": "https://identity:35357/v3/regions?parent_region_id=8ebd7f" }, - "parent_region_id": "829551" + "parent_region_id": "829551", + "url": "http://example.com/auth" } } @@ -2113,7 +2123,8 @@ Request: { "region": { "description": "US Southwest Subregion 1", - "parent_region_id": "us-south" + "parent_region_id": "us-south", + "url": "http://example.com/auth" } } @@ -2129,7 +2140,8 @@ Response: "self": "https://identity:35357/v3/regions/us-southwest-1", "child_regions": "https://identity:35357/v3/regions?parent_region_id=us-southwest-1" }, - "parent_region_id": "us-south" + "parent_region_id": "us-south", + "url": "http://example.com/auth" } } @@ -2151,7 +2163,8 @@ Request: { "region": { "description": "US Southwest Subregion", - "parent_region_id": "us-southwest" + "parent_region_id": "us-southwest", + "url": "http://example.com/auth" } } @@ -2167,7 +2180,8 @@ Response: "self": "https://identity:35357/v3/regions/us-southwest-1", "child_regions": "https://identity:35357/v3/regions?parent_region_id=us-southwest-1" }, - "parent_region_id": "us-southwest" + "parent_region_id": "us-southwest", + "url": "http://example.com/auth" } }