Release pti-o2imsdms 2.0.0 image

[pti/o2.git] / docs / api.rst

diff --git a/docs/api.rst b/docs/api.rst
index a97adb1..1b1e5aa 100644 (file)
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2021 Wind River Systems, Inc.
+.. Copyright (C) 2021-2022 Wind River Systems, Inc.
 
-O-Cloud O2 Services API 1.0.0
-=============================
+INF O2 Services API 1.0.0
+=========================
 
 .. toctree::
     :maxdepth: 3
@@ -12,7 +12,7 @@ O-Cloud O2 Services API 1.0.0
 Description
 ~~~~~~~~~~~
 
-Swagger OpenAPI document for O-Cloud O2 Services
+Swagger OpenAPI document for the INF O2 Services
 
 
 
@@ -33,8 +33,8 @@ DMS LCM related operations.
 
 
 
-POST ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
-----------------------------------------------------------------------------
+POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
+-------------------------------------------------------------------------------
 
 
 
@@ -116,8 +116,8 @@ DMS LCM not found
 
 
 
-POST ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
---------------------------------------------------------------------------------------
+POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
+-----------------------------------------------------------------------------------------
 
 
 
@@ -203,8 +203,8 @@ DMS LCM not found
 
 
 
-DELETE ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
------------------------------------------------------------------------------------------------
+DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
+--------------------------------------------------------------------------------------------------
 
 
 
@@ -244,8 +244,8 @@ DMS LCM not found
 
 
 
-DELETE ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
--------------------------------------------------------------------------------------------------------------------
+DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
+----------------------------------------------------------------------------------------------------------------------
 
 
 
@@ -285,8 +285,8 @@ DMS LCM not found
 
 
 
-GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
---------------------------------------------------------------------------------------------
+GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
+-----------------------------------------------------------------------------------------------
 
 
 
@@ -349,8 +349,8 @@ DMS LCM not found
 
 
 
-GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
-----------------------------------------------------------------------------------------------------------------
+GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
+-------------------------------------------------------------------------------------------------------------------
 
 
 
@@ -414,8 +414,8 @@ DMS LCM not found
 
 
 
-GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
----------------------------------------------------------------------------
+GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
+------------------------------------------------------------------------------
 
 
 
@@ -488,8 +488,8 @@ DMS LCM not found
 
 
 
-GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
--------------------------------------------------------------------------------------
+GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
+----------------------------------------------------------------------------------------
 
 
 
@@ -564,8 +564,8 @@ DMS LCM not found
 
 
 
-GET ``/o2dms/{deploymentManagerID}``
-------------------------------------
+GET ``/o2dms/v1/{deploymentManagerID}``
+---------------------------------------
 
 
 
@@ -627,8 +627,8 @@ Deployment manager not found
 
 
 
-PUT ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
---------------------------------------------------------------------------------------------
+PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
+-----------------------------------------------------------------------------------------------
 
 
 
@@ -685,8 +685,8 @@ DMS LCM not found
 
 
 
-PUT ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
-----------------------------------------------------------------------------------------------------------------
+PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
+-------------------------------------------------------------------------------------------------------------------
 
 
 
@@ -877,6 +877,7 @@ Parameters
     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
     :widths: 20, 15, 10, 10, 10, 20, 30
 
+        profile | query | No | string |  |  | DMS profile: value supports "sol018"
         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 
 
@@ -914,6 +915,14 @@ Type: :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
         "deploymentManagerId": "somestring",
         "description": "somestring",
         "name": "somestring",
+        "profileData": {
+            "admin_client_cert": "somestring",
+            "admin_client_key": "somestring",
+            "admin_user": "somestring",
+            "cluster_api_endpoint": "somestring",
+            "cluster_ca_cert": "somestring"
+        },
+        "profileName": "somestring",
         "supportedLocations": "somestring"
     }
 
@@ -1319,7 +1328,7 @@ Responses
 Success
 
 
-Type: array of :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
+Type: array of :ref:`DeploymentManagerListDto <d_b50b514bc3afc99684dcf3a7c2fc8b60>`
 
 
 **Example:**
@@ -1334,6 +1343,10 @@ Type: array of :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e
             "deploymentManagerId": "somestring",
             "description": "somestring",
             "name": "somestring",
+            "profileSupportList": [
+                "somestring",
+                "somestring"
+            ],
             "supportedLocations": "somestring"
         },
         {
@@ -1343,6 +1356,10 @@ Type: array of :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e
             "deploymentManagerId": "somestring",
             "description": "somestring",
             "name": "somestring",
+            "profileSupportList": [
+                "somestring",
+                "somestring"
+            ],
             "supportedLocations": "somestring"
         }
     ]
@@ -1529,6 +1546,8 @@ Parameters
     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
     :widths: 20, 15, 10, 10, 10, 20, 30
 
+        parentId | query | No | string |  |  | filter parentId
+        resourceTypeName | query | No | string |  |  | filter resource type
         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
 
 
@@ -1826,6 +1845,43 @@ DeploymentManagerGetDto Model Structure
         deploymentManagerId | Yes | string |  |  | Deployment manager ID
         description | No | string |  |  | 
         name | No | string |  |  | 
+        profileData | No | :ref:`DeploymentManagerGetDtoProfile <d_51fed249638cf054f9cc4c7832c7cbe4>` |  |  | 
+        profileName | No | string |  |  | 
+        supportedLocations | No | string |  |  | 
+
+.. _d_51fed249638cf054f9cc4c7832c7cbe4:
+
+DeploymentManagerGetDtoProfile Model Structure
+----------------------------------------------
+
+.. csv-table::
+    :delim: |
+    :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+    :widths: 20, 10, 15, 15, 30, 25
+
+        admin_client_cert | No | string |  |  | 
+        admin_client_key | No | string |  |  | 
+        admin_user | No | string |  |  | 
+        cluster_api_endpoint | No | string |  |  | 
+        cluster_ca_cert | No | string |  |  | 
+
+.. _d_b50b514bc3afc99684dcf3a7c2fc8b60:
+
+DeploymentManagerListDto Model Structure
+----------------------------------------
+
+.. csv-table::
+    :delim: |
+    :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+    :widths: 20, 10, 15, 15, 30, 25
+
+        capabilities | No | string |  |  | 
+        capacity | No | string |  |  | 
+        deploymentManagementServiceEndpoint | No | string |  |  | 
+        deploymentManagerId | Yes | string |  |  | Deployment manager ID
+        description | No | string |  |  | 
+        name | No | string |  |  | 
+        profileSupportList | No | array of string |  |  | Profile support list, use default for the return                      endpoint
         supportedLocations | No | string |  |  | 
 
 .. _d_086ee84f2c2cf010478bfc73a87b5e80: