From 92bb42934798b47879f42895cdcccb43ca84d7cc Mon Sep 17 00:00:00 2001 From: Yogeshwar Srikrishnan Date: Fri, 9 Sep 2011 16:49:41 -0500 Subject: Introducing doc to support OS-KSCATALOG extensions.Adding new calls to OS-KSADM extension document. Change-Id: Iac701b53f547be254517993388d199ef6980c455 --- keystone/content/admin/OS-KSADM-admin-devguide.pdf | Bin 0 -> 252678 bytes keystone/content/admin/OS-KSADM-admin.wadl | 100 +++++++++++++++---- .../content/admin/OS-KSCATALOG-admin-devguide.pdf | Bin 0 -> 136286 bytes keystone/content/admin/OS-KSCATALOG-admin.wadl | 66 ++++++++++++- .../content/admin/identity-OS-KSADM-dev-guide.pdf | Bin 219864 -> 0 bytes keystone/content/admin/identity-admin.wadl | 4 +- keystone/content/common/samples/credentials.json | 13 +++ keystone/content/common/samples/credentials.xml | 5 + .../content/common/samples/endpointTemplates.json | 109 +++++++++++---------- keystone/content/common/samples/norequestbody.txt | 1 + keystone/content/common/samples/noresponsebody.txt | 1 + .../common/samples/passwordcredentials.json | 6 ++ .../content/common/samples/passwordcredentials.xml | 4 + 13 files changed, 236 insertions(+), 73 deletions(-) create mode 100644 keystone/content/admin/OS-KSADM-admin-devguide.pdf create mode 100644 keystone/content/admin/OS-KSCATALOG-admin-devguide.pdf delete mode 100644 keystone/content/admin/identity-OS-KSADM-dev-guide.pdf create mode 100644 keystone/content/common/samples/credentials.json create mode 100644 keystone/content/common/samples/credentials.xml create mode 100644 keystone/content/common/samples/norequestbody.txt create mode 100644 keystone/content/common/samples/noresponsebody.txt create mode 100644 keystone/content/common/samples/passwordcredentials.json create mode 100644 keystone/content/common/samples/passwordcredentials.xml diff --git a/keystone/content/admin/OS-KSADM-admin-devguide.pdf b/keystone/content/admin/OS-KSADM-admin-devguide.pdf new file mode 100644 index 00000000..38c78de9 Binary files /dev/null and b/keystone/content/admin/OS-KSADM-admin-devguide.pdf differ diff --git a/keystone/content/admin/OS-KSADM-admin.wadl b/keystone/content/admin/OS-KSADM-admin.wadl index 8e484d0b..f7833579 100644 --- a/keystone/content/admin/OS-KSADM-admin.wadl +++ b/keystone/content/admin/OS-KSADM-admin.wadl @@ -65,7 +65,7 @@ - + @@ -93,7 +93,7 @@ - + @@ -194,6 +194,9 @@ Deletes a tenant.

This call deletes a tenant.

+ + + &commonFaults; @@ -266,6 +269,9 @@

Adds a specific role to a user for a tenant.

+ + + &commonFaults; @@ -276,6 +282,9 @@

Deletes a specific role from a user for a tenant.

+ + + &commonFaults; @@ -311,6 +320,8 @@

Update a user.

+ + @@ -336,6 +347,9 @@

Delete a user.

+ + + &commonFaults; @@ -371,9 +385,9 @@ - -

List roles for a user.

- + +

List all the global roles for a user.

+ @@ -390,8 +404,11 @@ - -

Adds a specific role to a user.

+ +

Adds a specific global role to a user.

+ + + &commonFaults; @@ -401,7 +418,7 @@ -

Get information about a role that belongs to a user.

+

Get information about a global role that belongs to a user.

@@ -417,8 +434,11 @@ - -

Deletes a specific role from a user.

+ +

Deletes a specific global role from a user.

+ + + &commonFaults; @@ -430,6 +450,15 @@

Adds a credential to a user.

+ + + + + + + + + @@ -447,9 +476,17 @@

List credentials.

+ + + + + + + + - + &commonFaults; @@ -459,9 +496,17 @@

List credentials by type.

+ + + + + + + + - + &commonFaults; @@ -471,6 +516,15 @@

Update credentials.

+ + + + + + + + + @@ -487,12 +541,12 @@ -

Delete credentials.

+

Delete User credentials.

+ + + - - - - + &commonFaults; &postPutFaults; &getFaults; @@ -501,6 +555,10 @@

Get user credentials.

+ + + + @@ -583,6 +641,9 @@

Delete a role.

+ + + &commonFaults; @@ -656,8 +717,11 @@ &getFaults; - +

Delete a service.

+ + + &commonFaults; diff --git a/keystone/content/admin/OS-KSCATALOG-admin-devguide.pdf b/keystone/content/admin/OS-KSCATALOG-admin-devguide.pdf new file mode 100644 index 00000000..028ee63d Binary files /dev/null and b/keystone/content/admin/OS-KSCATALOG-admin-devguide.pdf differ diff --git a/keystone/content/admin/OS-KSCATALOG-admin.wadl b/keystone/content/admin/OS-KSCATALOG-admin.wadl index 5abf9644..8ec4c136 100644 --- a/keystone/content/admin/OS-KSCATALOG-admin.wadl +++ b/keystone/content/admin/OS-KSCATALOG-admin.wadl @@ -43,7 +43,7 @@ - + @@ -78,6 +78,13 @@ + +

List Endpoint Templates.

+ + + + + @@ -90,6 +97,13 @@ + +

Get Endpoint Template.

+ + + + + @@ -99,6 +113,17 @@ + +

Add Endpoint Template.

+ + + + + + + + + @@ -117,12 +142,29 @@ + +

Delete a Endpoint Template.

+ + + + &commonFaults; &getFaults; + +

Add Endpoint to a tenant.

+ + + + + + + + + @@ -140,7 +182,14 @@ &postPutFaults; - + + +

List Endpoints of a Tenant.

+ + + + + @@ -150,6 +199,13 @@ + +

Get Endpoint of a Tenant.

+ + + + + @@ -159,6 +215,12 @@ + +

Delete a Endpoint from a Tenant.

+ + + + &commonFaults; &getFaults; diff --git a/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf b/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf deleted file mode 100644 index e5ec2014..00000000 Binary files a/keystone/content/admin/identity-OS-KSADM-dev-guide.pdf and /dev/null differ diff --git a/keystone/content/admin/identity-admin.wadl b/keystone/content/admin/identity-admin.wadl index 2af24d56..b4b6767f 100644 --- a/keystone/content/admin/identity-admin.wadl +++ b/keystone/content/admin/identity-admin.wadl @@ -230,7 +230,7 @@

- Check that a token is valid and that it belongs to a particular user + Check that a token is valid and that it belongs to a supplied tenant and return the permissions relevant to a particular client.

@@ -264,7 +264,7 @@

- Check that a token is valid and that it belongs to a particular user + Check that a token is valid and that it belongs to a particular tenant (For performance).

diff --git a/keystone/content/common/samples/credentials.json b/keystone/content/common/samples/credentials.json new file mode 100644 index 00000000..66f77cfa --- /dev/null +++ b/keystone/content/common/samples/credentials.json @@ -0,0 +1,13 @@ +{ + "credentials": { + "values": [ + { + "passwordCredentials": { + "username": "test_user", + "password": "mypass" + } + } + ], + "links": [] + } +} diff --git a/keystone/content/common/samples/credentials.xml b/keystone/content/common/samples/credentials.xml new file mode 100644 index 00000000..1d6a7cb1 --- /dev/null +++ b/keystone/content/common/samples/credentials.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/keystone/content/common/samples/endpointTemplates.json b/keystone/content/common/samples/endpointTemplates.json index adf7fa63..f7638570 100644 --- a/keystone/content/common/samples/endpointTemplates.json +++ b/keystone/content/common/samples/endpointTemplates.json @@ -1,54 +1,61 @@ { -"OS-KSCATALOG:endpointsTemplates": [ - { - "id": 1, - "region": "North", - "global": true, - "type": "compute", - "publicURL": "https://compute.north.public.com/v1", - "internalURL": "https://compute.north.internal.com/v1", - "versionId": "1", - "versionInfo": "https://compute.north.public.com/v1/", - "versionList": "https://compute.north.public.com/", - "enabled": true - }, { - "id": 2, - "region": "South", - "type": "compute", - "publicURL": "https://compute.south.public.com/v1", - "internalURL": "https://compute.south.internal.com/v1", - "versionId": "1", - "versionInfo": "https://compute.south.public.com/v1/", - "versionList": "https://compute.south.public.com/", - "enabled": false - }, { - "id": 3, - "region": "North", - "global": true, - "type": "object-store", - "publicURL": "https://object-store.north.public.com/v1.0", - "versionId": "1.0", - "versionInfo": "https://object-store.north.public.com/v1.0/", - "versionList": "https://object-store.north.public.com/", - "enabled": true - }, { - "id": 4, - "region": "South", - "type": "object-store", - "publicURL": "https://object-store.south.public.com/v2", - "versionId": "2", - "versionInfo": "https://object-store.south.public.com/v2/", - "versionList": "https://object-store.south.public.com/", - "enabled": true - }, { - "id": 5, - "global": true, - "type": "OS-DNS:DNS", - "publicURL": "https://dns.public.com/v3.2", - "versionId": "1.0", - "versionInfo": "https://dns.public.com/v1.0/", - "versionList": "https://dns.public.com/", - "enabled": true + "OS-KSCATALOG:endpointsTemplates": { + "values": [ + { + "id": 1, + "region": "North", + "global": true, + "type": "compute", + "publicURL": "https://compute.north.public.com/v1", + "internalURL": "https://compute.north.internal.com/v1", + "versionId": "1", + "versionInfo": "https://compute.north.public.com/v1/", + "versionList": "https://compute.north.public.com/", + "enabled": true + }, + { + "id": 2, + "region": "South", + "type": "compute", + "publicURL": "https://compute.south.public.com/v1", + "internalURL": "https://compute.south.internal.com/v1", + "versionId": "1", + "versionInfo": "https://compute.south.public.com/v1/", + "versionList": "https://compute.south.public.com/", + "enabled": false + }, + { + "id": 3, + "region": "North", + "global": true, + "type": "object-store", + "publicURL": "https://object-store.north.public.com/v1.0", + "versionId": "1.0", + "versionInfo": "https://object-store.north.public.com/v1.0/", + "versionList": "https://object-store.north.public.com/", + "enabled": true + }, + { + "id": 4, + "region": "South", + "type": "object-store", + "publicURL": "https://object-store.south.public.com/v2", + "versionId": "2", + "versionInfo": "https://object-store.south.public.com/v2/", + "versionList": "https://object-store.south.public.com/", + "enabled": true + }, + { + "id": 5, + "global": true, + "type": "OS-DNS:DNS", + "publicURL": "https://dns.public.com/v3.2", + "versionId": "1.0", + "versionInfo": "https://dns.public.com/v1.0/", + "versionList": "https://dns.public.com/", + "enabled": true + } + ], + "links": [] } - ] } diff --git a/keystone/content/common/samples/norequestbody.txt b/keystone/content/common/samples/norequestbody.txt new file mode 100644 index 00000000..c6a777d5 --- /dev/null +++ b/keystone/content/common/samples/norequestbody.txt @@ -0,0 +1 @@ +This operation does not require a request body. diff --git a/keystone/content/common/samples/noresponsebody.txt b/keystone/content/common/samples/noresponsebody.txt new file mode 100644 index 00000000..96e583f9 --- /dev/null +++ b/keystone/content/common/samples/noresponsebody.txt @@ -0,0 +1 @@ +This operation does not return a response body. diff --git a/keystone/content/common/samples/passwordcredentials.json b/keystone/content/common/samples/passwordcredentials.json new file mode 100644 index 00000000..f405fa79 --- /dev/null +++ b/keystone/content/common/samples/passwordcredentials.json @@ -0,0 +1,6 @@ +{ + "passwordCredentials": { + "username": "test_user", + "password": "mypass" + } +} diff --git a/keystone/content/common/samples/passwordcredentials.xml b/keystone/content/common/samples/passwordcredentials.xml new file mode 100644 index 00000000..86e4d9fe --- /dev/null +++ b/keystone/content/common/samples/passwordcredentials.xml @@ -0,0 +1,4 @@ + + + -- cgit