openstack-attic/identity-api
Code Issues Proposed changes

Merge "Cleanup Endpoint V3 documentation"

Browse Source
This commit is contained in:
Jenkins
2014-02-27 16:01:51 +00:00
committed by Gerrit Code Review
parent 2cbf8b20b2 d24961c722
commit ab83c7fc35
1 changed files with 52 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
openstack-identity-api/v3/src/markdown/identity-api-v3.md
View File

@@ -2044,44 +2044,65 @@ Response:
{
"endpoints": [
{
"id": "--endpoint-id--",
"enabled": true,
"id": "6fedc0",
"interface": "public",
"links": {
"self": "http://identity:35357/v3/endpoints/--endpoint-id--"
"self": "https://identity:35357/v3/endpoints/6fedc0"
},
"name": "the public volume endpoint",
"region": "--region--",
"service_id": "--service-id--"
"region_id": "us-east-1",
"service_id": "ee057c",
"url": "https://service.example.com:5000/"
},
{
"id": "--endpoint-id--",
"interface": "internal",
"enabled": true,
"id": "d12b15",
"interface": "admin",
"links": {
"self": "http://identity:35357/v3/endpoints/--endpoint-id--"
"self": "https://identity:35357/v3/endpoints/d12b15"
},
"name": "the internal volume endpoint",
"region": "--region--",
"service_id": "--service-id--"
"region_id": "us-east-2",
"service_id": "8ef7de",
"url": "https://service.example.com:35357/"
}
],
"links": {
"self": "http://identity:35357/v3/endpoints",
"self": "https://identity:35357/v3/endpoints",
"previous": null,
"next": null
}
}
#### Get endpoint: `GET /endpoints/{endpoint_id}`
Response:
Status: 200 OK
{
"endpoint": {
"enabled": true,
"id": "6fedc0",
"interface": "public",
"links": {
"self": "https://identity:35357/v3/endpoints/6fedc0"
},
"region_id": "us-east-2",
"service_id": "ee057c",
"url": "https://service.example.com:5000/"
}
}
#### Create endpoint: `POST /endpoints`
Request:
{
"endpoint": {
"interface": "[admin|public|internal]",
"name": "name",
"region": "--optional--",
"url": "...",
"service_id": "--service-id--"
"interface": "admin",
"region_id": "us-east-2",
"url": "https://service.example.com/",
"service_id": "ee057c"
}
}
@@ -2091,14 +2112,15 @@ Response:
{
"endpoint": {
"id": "--endpoint-id--",
"interface": "internal",
"enabled": true,
"id": "6fedc0",
"interface": "admin",
"links": {
"self": "http://identity:35357/v3/endpoints/--endpoint-id--"
"self": "https://identity:35357/v3/endpoints/6fedc0"
},
"name": "the internal volume endpoint",
"region": "--region--",
"service_id": "--service-id--"
"region_id": "us-east-2",
"service_id": "ee057c",
"url": "https://service.example.com:35357/"
}
}
@@ -2114,14 +2136,15 @@ Response:
{
"endpoint": {
"id": "--endpoint-id--",
"interface": "internal",
"enabled": true,
"id": "6fedc0",
"interface": "public",
"links": {
"self": "http://identity:35357/v3/endpoints/--endpoint-id--"
"self": "https://identity:35357/v3/endpoints/6fedc0"
},
"name": "the internal volume endpoint",
"region": "--region--",
"service_id": "--service-id--"
"region_id": "us-east-1",
"service_id": "ee057c",
"url": "https://service.example.com:5000/"
}
}