openstack-attic/identity-api
Code Issues Proposed changes

Cleanup region V3 documentation

Browse Source 
Use more realistic examples for the regions Identity V3 documentation.

Change-Id: I47f62ae6845a896509f1c54dafca1a0c2178f1aa
This commit is contained in:
Lance Bragstad 2014-06-06 12:46:30 +00:00
parent d3306c8271
commit 8ee7f3856a
1 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
v3/src/markdown/identity-api-v3.md
View File

@ -858,7 +858,7 @@ Example entity:
"description": "2nd sub-region inside the US East region.",
"id": "us-east-2",
"links": {
"self": "http://identity:35357/v3/regions/us-east-2"
"self": "https://identity:35357/v3/regions/us-east-2"
},
"parent_region_id": "us-east"
}
@ -1796,18 +1796,18 @@ Response:
{
"regions": [
{
"description": "--description--",
"id": "--region-id--",
"description": "US East Region",
"id": "us-east",
"links": {
"self": "http://identity:35357/v3/regions/--region-id--",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=--region-id--"
"self": "https://identity:35357/v3/regions/us-east",
"child_regions": "https://identity:35357/v3/regions?parent_region_id=us-east"
},
"parent_region_id": "--parent-region-id--"
"parent_region_id": "us-east-coast"
},
...
],
"links": {
"self": "http://identity:35357/v3/regions",
"self": "https://identity:35357/v3/regions",
"previous": null,
"next": null
}
@ -1821,13 +1821,13 @@ Response:
{
"region": {
"description": "--description--",
"id": "--region-id--",
"description": "US Southwest Region",
"id": "us-southwest",
"links": {
"self": "http://identity:35357/v3/regions/--region-id--",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=--region-id--"
"self": "https://identity:35357/v3/regions/us-southwest",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=us-southwest"
},
"parent_region_id": "--parent-region-id--"
"parent_region_id": "us-west-coast"
}
}
@ -1837,8 +1837,8 @@ Request:
{
"region": {
"description": "--region-description--",
"parent_region_id": "--parent-region-id--"
"description": "US West Subregion 1",
"parent_region_id": "829551"
}
}
@ -1848,13 +1848,13 @@ Response:
{
"region": {
"description": "--description--",
"id": "--region-id--",
"description": "US West Subregion 1",
"id": "8ebd7f",
"links": {
"self": "http://identity:35357/v3/regions/--region-id--",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=--region-id--"
"self": "https://identity:35357/v3/regions/8ebd7f",
"child_regions": "https://identity:35357/v3/regions?parent_region_id=8ebd7f"
},
"parent_region_id": "--parent-region-id--"
"parent_region_id": "829551"
}
}
@ -1869,8 +1869,8 @@ Request:
{
"region": {
"description": "--region-description--",
"parent_region_id": "--parent-region-id--"
"description": "US Southwest Subregion 1",
"parent_region_id": "us-south"
}
}
@ -1880,13 +1880,13 @@ Response:
{
"region": {
"description": "--description--",
"id": "--region-id--",
"description": "US Southwest Subregion 1",
"id": "us-southwest-1",
"links": {
"self": "http://identity:35357/v3/regions/--region-id--",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=--region-id--"
"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": "--parent-region-id--"
"parent_region_id": "us-south"
}
}
@ -1905,8 +1905,8 @@ Request:
{
"region": {
"description": "...",
"parent_region_id": "--parent-region-id--"
"description": "US Southwest Subregion",
"parent_region_id": "us-southwest"
}
}
@ -1916,13 +1916,13 @@ Response:
{
"region": {
"description": "--description--",
"id": "--region-id--",
"description": "US Southwest Subregion",
"id": "us-southwest-1",
"links": {
"self": "http://identity:35357/v3/regions/--region-id--",
"child_regions": "http://identity:35357/v3/regions?parent_region_id=--region-id--"
"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": "--parent-region-id--"
"parent_region_id": "us-southwest"
}
}