openstack/tripleo-specs
Code Issues Proposed changes

Corrects some inconsistencies in REST API spec

Browse Source 
Changes ids in json examples to uuids.
Changes example for adding role to plan to contain name and version.
Changes /v2/clouds to /v2/plans.

Change-Id: Id242a877b38409978ef337a1e4f5cc5955b21b95
This commit is contained in:
Petr Blaho 2014-07-23 19:01:36 +02:00
parent 298fc2eae5
commit d48dbc99dc
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
specs/juno/tripleo-juno-tuskar-rest-api.rst
View File

@ -145,13 +145,13 @@ Response Example:
.. code-block:: json .. code-block:: json
{ {
"id" : "dd4ef003-c855-40ba-b5a6-3fe4176a069e", "uuid" : "dd4ef003-c855-40ba-b5a6-3fe4176a069e",
"name" : "dev-cloud", "name" : "dev-cloud",
"description" : "Development testing cloud", "description" : "Development testing cloud",
"last_modified" : "2014-05-28T21:11:09Z", "last_modified" : "2014-05-28T21:11:09Z",
"roles" : [ "roles" : [
{ {
"id" : "55713e6a-79f5-42e1-aa32-f871b3a0cb64", "uuid" : "55713e6a-79f5-42e1-aa32-f871b3a0cb64",
"name" : "compute", "name" : "compute",
"version" : "1", "version" : "1",
"links" : { "links" : {
@ -160,7 +160,7 @@ Response Example:
} }
}, },
{ {
"id" : "2ca53130-b9a4-4fa5-86b8-0177e8507803", "uuid" : "2ca53130-b9a4-4fa5-86b8-0177e8507803",
"name" : "controller", "name" : "controller",
"version" : "1", "version" : "1",
"links" : { "links" : {
@ -179,7 +179,7 @@ Response Example:
], ],
"links" : [ "links" : [
{ {
"href" : "http://server/v2/clouds/dd4ef003-c855-40ba-b5a6-3fe4176a069e/", "href" : "http://server/v2/plans/dd4ef003-c855-40ba-b5a6-3fe4176a069e/",
"rel" : "self" "rel" : "self"
} }
] ]
@ -251,20 +251,20 @@ Response Example:
[ [
{ {
"id" : "3e61b4b2-259b-4b91-8344-49d7d6d292b6", "uuid" : "3e61b4b2-259b-4b91-8344-49d7d6d292b6",
"name" : "dev-cloud", "name" : "dev-cloud",
"description" : "Development testing cloud", "description" : "Development testing cloud",
"links" : { "links" : {
"href" : "http://server/v2/clouds/3e61b4b2-259b-4b91-8344-49d7d6d292b6/", "href" : "http://server/v2/plans/3e61b4b2-259b-4b91-8344-49d7d6d292b6/",
"rel" : "bookmark" "rel" : "bookmark"
} }
}, },
{ {
"id" : "135c7391-6c64-4f66-8fba-aa634a86a941", "uuid" : "135c7391-6c64-4f66-8fba-aa634a86a941",
"name" : "qe-cloud", "name" : "qe-cloud",
"description" : "QE testing cloud", "description" : "QE testing cloud",
"links" : { "links" : {
"href" : "http://server/v2/clouds/135c7391-6c64-4f66-8fba-aa634a86a941/", "href" : "http://server/v2/plans/135c7391-6c64-4f66-8fba-aa634a86a941/",
"rel" : "bookmark" "rel" : "bookmark"
} }
} }
@ -380,7 +380,8 @@ Request Example:
.. code-block:: json .. code-block:: json
{ {
"id" : "651c26f6-63e2-4e76-9b60-614b51249677" "name" : "compute",
"version" : "2"
} }
Response Codes: Response Codes:
@ -507,19 +508,19 @@ Response Example:
[ [
{ {
"id" : "3d46e510-6a63-4ed1-abd0-9306a451f8b4", "uuid" : "3d46e510-6a63-4ed1-abd0-9306a451f8b4",
"name" : "compute", "name" : "compute",
"version" : "1", "version" : "1",
"description" : "Nova Compute" "description" : "Nova Compute"
}, },
{ {
"id" : "71d6c754-c89c-4293-9d7b-c4dcc57229f0", "uuid" : "71d6c754-c89c-4293-9d7b-c4dcc57229f0",
"name" : "compute", "name" : "compute",
"version" : "2", "version" : "2",
"description" : "Nova Compute" "description" : "Nova Compute"
}, },
{ {
"id" : "651c26f6-63e2-4e76-9b60-614b51249677", "uuid" : "651c26f6-63e2-4e76-9b60-614b51249677",
"name" : "controller", "name" : "controller",
"version" : "1", "version" : "1",
"description" : "Controller Services" "description" : "Controller Services"