X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi.rst;fp=docs%2Fapi.rst;h=32c8f90baf4b5cb7fe1354110e0a51b57c0a8287;hb=513d34988f76825846a2379078eb4aedcaed9f27;hp=4763897b681b037c87b9f26b9e093ee69a5566a0;hpb=1a9dcb5b8f598ee348f23eafecc2d92ef09c8122;p=pti%2Fo2.git diff --git a/docs/api.rst b/docs/api.rst index 4763897..32c8f90 100644 --- 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. INF O2 Services API 1.0.0 -============================= +========================= .. toctree:: :maxdepth: 3 @@ -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 "sol0018" deploymentManagerID | path | Yes | string | | | ID of the deployment manager @@ -914,6 +915,14 @@ Type: :ref:`DeploymentManagerGetDto ` "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 ` +Type: array of :ref:`DeploymentManagerListDto ` **Example:** @@ -1334,6 +1343,10 @@ Type: array of :ref:`DeploymentManagerGetDto ` | | | + 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: