Revise docs
[multicloud/framework.git] / docs / MultiCloud-API-Specification-V1.rst
index 398d43f..ab0e3e9 100644 (file)
@@ -1,3 +1,7 @@
+..
+ This work is licensed under a Creative Commons Attribution 4.0
+ International License.
+
 ================================
 MultiCloud API Specification V1
 ================================
@@ -438,33 +442,33 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……}
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| 200: ok                                         |                 |                   |
-|                                                 |                 |                   |
-| 500: failed                                     |                 |                   |
-|                                                 |                 |                   |
-| {                                               |                 |                   |
-|                                                 |                 |                   |
-|  “vimid”:””                                     |                 |                   |
-|                                                 |                 |                   |
-| “vimname”:””                                    |                 |                   |
-|                                                 |                 |                   |
-| "imageList": [                                  |                 |                   |
+| 200: ok                                         |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+| 500: failed                                     |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+| {                                               |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+|  “vimid”:””                                     |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+| “vimname”:””                                    |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+| "imageList": [                                  |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| {                                               |                 |                   |
+| {                                               |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| "status": "active",                             |                 |
+| "status": "active",                             |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| "id": "5e2757c1-f846-4727-915c-9a872553ed75",   |
+| "id": "5e2757c1-f846-4727-915c-9a872553ed75",   |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| "size": 862016,                                 |                 |
+| "size": 862016,                                 |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| "name": "vim-plus-cgsl40g-z.qcow2"              |
+| "name": "vim-plus-cgsl40g-z.qcow2"              |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| }                                               |                 |                   |
+| }                                               |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
-| ]                                               |                 |                   |
-|                                                 |                 |                   |
-| }                                               |                 |                   |
+| ]                                               |                 |                   |               |                                                        |
+|                                                 |                 |                   |               |                                                        |
+| }                                               |                 |                   |               |                                                        |
 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 
 1. \ **Get Image**
@@ -574,26 +578,25 @@ a}
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | routerExternal              | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| {                           |                 |
+| {                           |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “tenant”: “tenant1”,        |                 |
+| “tenant”: “tenant1”,        |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “networkName”: “ommnet”,    |
+| “networkName”: “ommnet”,    |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “shared”: 1,                |                 |
+| “shared”: 1,                |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “vlanTransparent”: 1,       |                 |
+| “vlanTransparent”: 1,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “networkType”:”vlan”,       |                 |
+| “networkType”:”vlan”,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “segmentationId”:202,       |                 |
-+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| “physicalNetwork”:”ctrl”,   |                 |
-|                             |                 |
-| “routerExternal”:0          |                 |
+| “segmentationId”:202,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| “physicalNetwork”:”ctrl”,   |                 |                   |               |                                                                                                                                                                                                                                                                                           |
+|                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
+| “routerExternal”:0          |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| }                           |                 |
+| }                           |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 1. \ **Response**