summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBin Yang <bin.yang@windriver.com>2019-05-15 08:38:04 +0000
committerBin Yang <bin.yang@windriver.com>2019-05-15 08:58:47 +0000
commitcd65ac58bf09b45144f6de2709279a549da4cb4a (patch)
treea6e0b3453ebe158d18a331ee57a5776a2f6aed15 /docs
parent6eefba51d9709d9b39c61bd02b46d83b6be40897 (diff)
Add Proxied OpenStack API
Add token API description Change-Id: Ide1978cd41d611c25de6d3a2d44bc274e9b19949 Issue-ID: MULTICLOUD-283 Signed-off-by: Bin Yang <bin.yang@windriver.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/MultiCloud-APIv0-Specification.rst103
-rw-r--r--docs/MultiCloud-APIv1-Specification.rst100
2 files changed, 203 insertions, 0 deletions
diff --git a/docs/MultiCloud-APIv0-Specification.rst b/docs/MultiCloud-APIv0-Specification.rst
index ea6f436..a2f0d98 100644
--- a/docs/MultiCloud-APIv0-Specification.rst
+++ b/docs/MultiCloud-APIv0-Specification.rst
@@ -2682,3 +2682,106 @@ NA
204: No content found
400: failed
+
+
+
+
+14. **Proxied OpenStack APIs**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+14.1. **Tokens**
+-------------------------
+
++---------------------+----------------------------------------------------------------------------------------------+
+| **IF Definition** | **Description** |
++=====================+==============================================================================================+
+| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/identity/v3/auth/tokens|
++---------------------+----------------------------------------------------------------------------------------------+
+| Operation | POST |
++---------------------+----------------------------------------------------------------------------------------------+
+| Direction | NSLCM-> MULTICLOUD |
++---------------------+----------------------------------------------------------------------------------------------+
+
+14.1.1. **Request**
+>>>>>>>>>>>>>>>>>>>
+
++-----------------+-----------------+-------------------+---------------+-----------------------+
+| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
++=================+=================+===================+===============+=======================+
+| auth | O | 1 | Object | Same as OpenStack Identity Tokens API |
++-----------------+-----------------+-------------------+---------------+-----------------------+
+
+::
+
+ {
+
+ }
+
+14.1.2. **Response**
+>>>>>>>>>>>>>>>>>>>>
+
+
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
++=================+=================+===================+=====================+==============================================================+
+| X-Subject-Token | M | 1 | String | The authentication token in Header |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| token | O | 1 | Object | Token response, the same as OpenStack Identity Tokens API |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+
+201: Created
+
+401: Unauthorized
+
+403: Forbidden
+
+500: failed
+
+
+::
+
+ Header:
+ X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
+
+ Body:
+
+ {
+ "token" : {
+ "user" : {
+ "domain" : {
+ "id" : "default",
+ "name" : "Default"
+ },
+ "id" : "9efb043c7629497a8028d7325ca1afb0",
+ "name" : "admin"
+ },
+ "catalog" : [
+ {
+ "type" : "network",
+ "endpoints" : [
+ {
+ "interface" : "public",
+ "id" : "39583c1508ad4b71b380570a745ee10a",
+ "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v0/CloudOwner_RegionOne/network",
+ "region_id" : "RegionOne",
+ "region" : "RegionOne"
+ }
+ ],
+ "name" : "neutron",
+ "id" : "99aefcc82a9246f98f8c281e61ffc754"
+ },
+ ...
+ ]
+ "project" : {
+ "name" : "admin",
+ "id" : "fcca3cc49d5e42caae15459e27103efc",
+ "domain" : {
+ "id" : "default",
+ "name" : "Default"
+ }
+ },
+ "is_domain" : false,
+ "expires_at" : "2017-09-11T03:52:29.000000Z"
+ }
+ }
+
diff --git a/docs/MultiCloud-APIv1-Specification.rst b/docs/MultiCloud-APIv1-Specification.rst
index dc5c551..4a9f78e 100644
--- a/docs/MultiCloud-APIv1-Specification.rst
+++ b/docs/MultiCloud-APIv1-Specification.rst
@@ -2544,3 +2544,103 @@ NA
404: Not Found
500: Internal Server Error
+
+
+15. **Proxied OpenStack APIs**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+15.1. **Tokens**
+-------------------------
+
++---------------------+----------------------------------------------------------------------------------------------+
+| **IF Definition** | **Description** |
++=====================+==============================================================================================+
+| URI | http://msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/identity/v3/auth/tokens|
++---------------------+----------------------------------------------------------------------------------------------+
+| Operation | POST |
++---------------------+----------------------------------------------------------------------------------------------+
+| Direction | NSLCM-> MULTICLOUD |
++---------------------+----------------------------------------------------------------------------------------------+
+
+15.1.1. **Request**
+>>>>>>>>>>>>>>>>>>>
+
++-----------------+-----------------+-------------------+---------------+-----------------------+
+| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
++=================+=================+===================+===============+=======================+
+| auth | O | 1 | Object | Same as OpenStack Identity Tokens API |
++-----------------+-----------------+-------------------+---------------+-----------------------+
+
+::
+
+ {
+
+ }
+
+15.1.2. **Response**
+>>>>>>>>>>>>>>>>>>>>
+
+
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
++=================+=================+===================+=====================+==============================================================+
+| X-Subject-Token | M | 1 | String | The authentication token in Header |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| token | O | 1 | Object | Token response, the same as OpenStack Identity Tokens API |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+
+201: Created
+
+401: Unauthorized
+
+403: Forbidden
+
+500: failed
+
+
+::
+
+ Header:
+ X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
+
+ Body:
+
+ {
+ "token" : {
+ "user" : {
+ "domain" : {
+ "id" : "default",
+ "name" : "Default"
+ },
+ "id" : "9efb043c7629497a8028d7325ca1afb0",
+ "name" : "admin"
+ },
+ "catalog" : [
+ {
+ "type" : "network",
+ "endpoints" : [
+ {
+ "interface" : "public",
+ "id" : "39583c1508ad4b71b380570a745ee10a",
+ "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v1/CloudOwner/RegionOne/network",
+ "region_id" : "RegionOne",
+ "region" : "RegionOne"
+ }
+ ],
+ "name" : "neutron",
+ "id" : "99aefcc82a9246f98f8c281e61ffc754"
+ },
+ ...
+ ]
+ "project" : {
+ "name" : "admin",
+ "id" : "fcca3cc49d5e42caae15459e27103efc",
+ "domain" : {
+ "id" : "default",
+ "name" : "Default"
+ }
+ },
+ "is_domain" : false,
+ "expires_at" : "2017-09-11T03:52:29.000000Z"
+ }
+ }