From: Zhang Rong(Jon) Date: Sun, 11 Dec 2022 05:04:01 +0000 (+0800) Subject: Update the API docs with swagger X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=eea8cbf069f08f04845a2480faef3bf142226652;p=pti%2Fo2.git Update the API docs with swagger Issue-ID: INF-387 Signed-off-by: Zhang Rong(Jon) Change-Id: I312f8d681ce161e6acc858638e8519cef9ec2543 (cherry picked from commit 48e72104985c9af63c778e79afb72e1b42a2e4de) --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst new file mode 100755 index 0000000..e2971dc --- /dev/null +++ b/docs/api-docs.rst @@ -0,0 +1,42 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021-2022 Wind River Systems, Inc. + +.. _api_docs: + +.. |swagger-icon| image:: ./images/swagger.png + :width: 40px + +.. |yaml-icon| image:: ./images/yaml_logo.png + :width: 40px + + +========================== +O-RAN O2 API Definition v1 +========================== + +This document defines how a SMO like application can perform the management +of O-Cloud infrastructures and the deployment life cycle management of O-RAN +cloudified NFs that run on O-Cloud via O-RAN O2 interfaces. + +The typical port used for the O-RAN O2 REST API is 30205. + +Here we describe the API to access the O2 API. + + +O-RAN O2 API v1 +=============== + +The O2 API v1 provides API includes O2ims_InfrastructureInventory, O2ims_InfrastructureMonitoring and +Kubernetes native API based O2dms interfaces. + +See `O-RAN O2 API v1 <./oran-o2-api.html>`_ for full details of the API. + +The API is also described in Swagger-JSON and YAML: + + +.. csv-table:: + :header: "API name", "|swagger-icon|", "|yaml-icon|" + :widths: 10,5, 5 + + "O-RAN O2 API", ":download:`link <./swagger.json>`", ":download:`link <./swagger.yaml>`" diff --git a/docs/api.rst b/docs/api.rst deleted file mode 100644 index 1b1e5aa..0000000 --- a/docs/api.rst +++ /dev/null @@ -1,2226 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021-2022 Wind River Systems, Inc. - -INF O2 Services API 1.0.0 -========================= - -.. toctree:: - :maxdepth: 3 - - -Description -~~~~~~~~~~~ - -Swagger OpenAPI document for the INF O2 Services - - - - - -Base URL -~~~~~~~~ - -http(s)://:30205/ - -O2DMS_LCM -~~~~~~~~~ - - -DMS LCM related operations. - - - - - -POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment`` -------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - - -.. _d_1cdf8e618b9847878bed90d4897e6b3a: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - descriptorId | No | string | | | - name | No | string | | | - parentDeploymentId | No | string | | | - -.. code-block:: javascript - - { - "description": "somestring", - "descriptorId": "somestring", - "name": "somestring", - "parentDeploymentId": "somestring" - } - -Responses -+++++++++ - -**201** -^^^^^^^ - -Success - - -Type: :ref:`NfDeploymentCreateRespDto ` - -**Example:** - -.. code-block:: javascript - - { - "id": "somestring" - } - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor`` ------------------------------------------------------------------------------------------ - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - - -.. _d_1583b74cb6544a428fadd82cb4ff4b3b: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifactName | No | string | | | - artifactRepoUrl | No | string | | | - description | No | string | | | - inputParams | No | string | | | - name | No | string | | | - outputParams | No | string | | | - -.. code-block:: javascript - - { - "artifactName": "somestring", - "artifactRepoUrl": "somestring", - "description": "somestring", - "inputParams": "somestring", - "name": "somestring", - "outputParams": "somestring" - } - -Responses -+++++++++ - -**201** -^^^^^^^ - -Success - - -Type: :ref:`NfDeploymentDescriptorCreateRespDto ` - -**Example:** - -.. code-block:: javascript - - { - "id": "somestring" - } - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}`` --------------------------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentId | path | Yes | string | | | ID of the NfDeployment - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Responses -+++++++++ - -**204** -^^^^^^^ - -NfDeployment deleted - - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}`` ----------------------------------------------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Responses -+++++++++ - -**204** -^^^^^^^ - -NfDeploymentDescriptor deleted - - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}`` ------------------------------------------------------------------------------------------------ - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentId | path | Yes | string | | | ID of the NfDeployment - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`NfDeploymentGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "description": "somestring", - "descriptorId": "somestring", - "id": "somestring", - "name": "somestring", - "parentDeploymentId": "somestring", - "status": 1 - } - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}`` -------------------------------------------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`NfDeploymentDescriptorGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "artifactName": "somestring", - "artifactRepoUrl": "somestring", - "description": "somestring", - "id": "somestring", - "inputParams": "somestring", - "name": "somestring", - "outputParams": "somestring" - } - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment`` ------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`NfDeploymentGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "description": "somestring", - "descriptorId": "somestring", - "id": "somestring", - "name": "somestring", - "parentDeploymentId": "somestring", - "status": 1 - }, - { - "description": "somestring", - "descriptorId": "somestring", - "id": "somestring", - "name": "somestring", - "parentDeploymentId": "somestring", - "status": 1 - } - ] - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor`` ----------------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`NfDeploymentDescriptorGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "artifactName": "somestring", - "artifactRepoUrl": "somestring", - "description": "somestring", - "id": "somestring", - "inputParams": "somestring", - "name": "somestring", - "outputParams": "somestring" - }, - { - "artifactName": "somestring", - "artifactRepoUrl": "somestring", - "description": "somestring", - "id": "somestring", - "inputParams": "somestring", - "name": "somestring", - "outputParams": "somestring" - } - ] - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -GET ``/o2dms/v1/{deploymentManagerID}`` ---------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`DmsGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "capabilities": "somestring", - "capacity": "somestring", - "deploymentManagerId": "somestring", - "description": "somestring", - "name": "somestring", - "supportedLocations": "somestring" - } - -**404** -^^^^^^^ - -Deployment manager not found - - - - - - -PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}`` ------------------------------------------------------------------------------------------------ - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentId | path | Yes | string | | | ID of the NfDeployment - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - - -.. _d_1a0e59d24d7db279637f186c203d883d: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - name | No | string | | | - parentDeploymentId | No | string | | | - -.. code-block:: javascript - - { - "description": "somestring", - "name": "somestring", - "parentDeploymentId": "somestring" - } - -Responses -+++++++++ - -**404** -^^^^^^^ - -DMS LCM not found - - - - - - -PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}`` -------------------------------------------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor - deploymentManagerID | path | Yes | string | | | ID of the deployment manager - - -Request -+++++++ - - - -.. _d_5a6ee319c7ac35eac173da7d57136a98: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifactName | No | string | | | - artifactRepoUrl | No | string | | | - description | No | string | | | - inputParams | No | string | | | - name | No | string | | | - outputParams | No | string | | | - -.. code-block:: javascript - - { - "artifactName": "somestring", - "artifactRepoUrl": "somestring", - "description": "somestring", - "inputParams": "somestring", - "name": "somestring", - "outputParams": "somestring" - } - -Responses -+++++++++ - -**404** -^^^^^^^ - -DMS LCM not found - - - - - -O2IMS_INVENTORY -~~~~~~~~~~~~~~~ - - -IMS Inventory related operations. - - - - - -POST ``/o2ims_infrastructureInventory/v1/subscriptions`` --------------------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - - -.. _d_0fff8519707c32c34f86d6ac19fad342: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - callback | Yes | string | | | Subscription callback address - consumerSubscriptionId | No | string | | | - filter | No | string | | | - -.. code-block:: javascript - - { - "callback": "somestring", - "consumerSubscriptionId": "somestring", - "filter": "somestring" - } - -Responses -+++++++++ - -**201** -^^^^^^^ - -Success - - -Type: :ref:`SubscriptionCreatedRespDto ` - -**Example:** - -.. code-block:: javascript - - { - "subscriptionId": "somestring" - } - - - - - -DELETE ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}`` ---------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - subscriptionID | path | Yes | string | | | ID of the subscription - - -Request -+++++++ - - -Responses -+++++++++ - -**204** -^^^^^^^ - -Subscription deleted - - -**404** -^^^^^^^ - -Subscription not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}`` ----------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :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 - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`DeploymentManagerGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "capabilities": "somestring", - "capacity": "somestring", - "deploymentManagementServiceEndpoint": "somestring", - "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" - } - -**404** -^^^^^^^ - -Deployment manager not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}`` ------------------------------------------------------------------------------------------------ - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - resourceID | path | Yes | string | | | ID of the resource - resourcePoolID | path | Yes | string | | | ID of the resource pool - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`ResourceGetDto2 ` - -**Example:** - -.. code-block:: javascript - - { - "children": [ - { - "children": [ - { - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - }, - { - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - } - ], - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - }, - { - "children": [ - { - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - }, - { - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - } - ], - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - } - ], - "description": "somestring", - "elements": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - } - -**404** -^^^^^^^ - -Resource not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}`` ------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - resourcePoolID | path | Yes | string | | | ID of the resource pool - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`ResourcePoolGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "description": "somestring", - "globalLocationId": "somestring", - "location": "somestring", - "name": "somestring", - "resourcePoolId": "somestring" - } - -**404** -^^^^^^^ - -Resource pool not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourceTypes/{resourceTypeID}`` ------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - resourceTypeID | path | Yes | string | | | ID of the resource type - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`ResourceTypeGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "description": "somestring", - "name": "somestring", - "resourceTypeId": "somestring", - "vendor": "somestring", - "version": "somestring" - } - -**404** -^^^^^^^ - -Resource type not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}`` ------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - subscriptionID | path | Yes | string | | | ID of the subscription - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`SubscriptionGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "callback": "somestring", - "consumerSubscriptionId": "somestring", - "filter": "somestring", - "subscriptionId": "somestring" - } - -**404** -^^^^^^^ - -Subscription not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/subscriptions`` -------------------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`SubscriptionGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "callback": "somestring", - "consumerSubscriptionId": "somestring", - "filter": "somestring", - "subscriptionId": "somestring" - }, - { - "callback": "somestring", - "consumerSubscriptionId": "somestring", - "filter": "somestring", - "subscriptionId": "somestring" - } - ] - - - - - -GET ``/o2ims_infrastructureInventory/v1/deploymentManagers`` ------------------------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`DeploymentManagerListDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "capabilities": "somestring", - "capacity": "somestring", - "deploymentManagementServiceEndpoint": "somestring", - "deploymentManagerId": "somestring", - "description": "somestring", - "name": "somestring", - "profileSupportList": [ - "somestring", - "somestring" - ], - "supportedLocations": "somestring" - }, - { - "capabilities": "somestring", - "capacity": "somestring", - "deploymentManagementServiceEndpoint": "somestring", - "deploymentManagerId": "somestring", - "description": "somestring", - "name": "somestring", - "profileSupportList": [ - "somestring", - "somestring" - ], - "supportedLocations": "somestring" - } - ] - - - - - -GET ``/o2ims_infrastructureInventory/v1/`` ------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`OcloudDto ` - -**Example:** - -.. code-block:: javascript - - { - "description": "somestring", - "globalCloudId": "somestring", - "infrastructureManagementServiceEndpoint": "somestring", - "name": "somestring", - "oCloudId": "somestring" - } - -**404** -^^^^^^^ - -oCloud not found - - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourcePools`` -------------------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`ResourcePoolGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "description": "somestring", - "globalLocationId": "somestring", - "location": "somestring", - "name": "somestring", - "resourcePoolId": "somestring" - }, - { - "description": "somestring", - "globalLocationId": "somestring", - "location": "somestring", - "name": "somestring", - "resourcePoolId": "somestring" - } - ] - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourceTypes`` -------------------------------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`ResourceTypeGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "description": "somestring", - "name": "somestring", - "resourceTypeId": "somestring", - "vendor": "somestring", - "version": "somestring" - }, - { - "description": "somestring", - "name": "somestring", - "resourceTypeId": "somestring", - "vendor": "somestring", - "version": "somestring" - } - ] - - - - - -GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources`` ----------------------------------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :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 - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`ResourceListDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "description": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - }, - { - "description": "somestring", - "name": "somestring", - "parentId": "somestring", - "resourceId": "somestring", - "resourcePoolId": "somestring", - "resourceTypeId": "somestring" - } - ] - - - - -PROVISION -~~~~~~~~~ - - -Provision related operations. - - - - - -POST ``/provision/v1/smo-endpoint`` ------------------------------------ - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - - -.. _d_18b723a8578a1c0bdb13e962c902ad94: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - endpoint | Yes | string | | | Configuration SMO callback address - -.. code-block:: javascript - - { - "endpoint": "somestring" - } - -Responses -+++++++++ - -**201** -^^^^^^^ - -Success - - -Type: :ref:`SmoEndpointCreatedRespDto ` - -**Example:** - -.. code-block:: javascript - - { - "id": "somestring" - } - - - - - -DELETE ``/provision/v1/smo-endpoint/{configurationID}`` -------------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - configurationID | path | Yes | string | | | ID of the SMO endpoint configuration - - -Request -+++++++ - - -Responses -+++++++++ - -**204** -^^^^^^^ - -Configuration deleted - - -**404** -^^^^^^^ - -SMO Endpoint configuration not found - - - - - - -GET ``/provision/v1/smo-endpoint/{configurationID}`` ----------------------------------------------------- - - - - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - configurationID | path | Yes | string | | | ID of the SMO endpoint configuration - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`SmoEndpointGetDto ` - -**Example:** - -.. code-block:: javascript - - { - "comments": "somestring", - "endpoint": "somestring", - "id": "somestring", - "status": "somestring" - } - -**404** -^^^^^^^ - -SMO Endpoint configuration not found - - - - - - -GET ``/provision/v1/smo-endpoint`` ----------------------------------- - - - - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: array of :ref:`SmoEndpointGetDto ` - - -**Example:** - -.. code-block:: javascript - - [ - { - "comments": "somestring", - "endpoint": "somestring", - "id": "somestring", - "status": "somestring" - }, - { - "comments": "somestring", - "endpoint": "somestring", - "id": "somestring", - "status": "somestring" - } - ] - - - - -Data Structures -~~~~~~~~~~~~~~~ - -.. _d_e936cc219a004ab92ac027b2690bdd5e: - -DeploymentManagerGetDto 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 | | | - profileData | No | :ref:`DeploymentManagerGetDtoProfile ` | | | - 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: - -DmsGetDto 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 | | | - deploymentManagerId | Yes | string | | | Deployment manager ID - description | No | string | | | - name | No | string | | | - supportedLocations | No | string | | | - -.. _d_1cdf8e618b9847878bed90d4897e6b4a: - -NfDeploymentCreateDto Model Structure -------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - descriptorId | No | string | | | - name | No | string | | | - parentDeploymentId | No | string | | | - -.. _d_c00d46ffd3e149e2989d2a5264585581: - -NfDeploymentCreateRespDto Model Structure ------------------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - id | Yes | string | | | NfDeployment ID - -.. _d_1583b74cb6544a428fadd82cb4ff4b4b: - -NfDeploymentDescriptorCreateDto Model Structure ------------------------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifactName | No | string | | | - artifactRepoUrl | No | string | | | - description | No | string | | | - inputParams | No | string | | | - name | No | string | | | - outputParams | No | string | | | - -.. _d_67c3fe14b244e803ad34a57f27b4bb4e: - -NfDeploymentDescriptorCreateRespDto Model Structure ---------------------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - id | Yes | string | | | NfDeploymentDescriptor ID - -.. _d_5bdce8ac307530aa532cc25654cd5b07: - -NfDeploymentDescriptorGetDto Model Structure --------------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifactName | No | string | | | - artifactRepoUrl | No | string | | | - description | No | string | | | - id | Yes | string | | | NfDeploymentDescriptor ID - inputParams | No | string | | | - name | No | string | | | - outputParams | No | string | | | - -.. _d_5a6ee319c7ac35eac173da7d57136a99: - -NfDeploymentDescriptorUpdateDto Model Structure ------------------------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifactName | No | string | | | - artifactRepoUrl | No | string | | | - description | No | string | | | - inputParams | No | string | | | - name | No | string | | | - outputParams | No | string | | | - -.. _d_e28dc7c38126e125615678304c7a9508: - -NfDeploymentGetDto Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - descriptorId | No | string | | | - id | Yes | string | | | NfDeployment ID - name | No | string | | | - parentDeploymentId | No | string | | | - status | No | integer | | | - -.. _d_1a0e59d24d7db279637f186c203d884d: - -NfDeploymentUpdateDto Model Structure -------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - name | No | string | | | - parentDeploymentId | No | string | | | - -.. _d_24d46c2729680edc54e60b2dfbea8ebf: - -OcloudDto Model Structure -------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - globalCloudId | No | string | | | - infrastructureManagementServiceEndpoint | No | string | | | - name | No | string | | | - oCloudId | Yes | string | | | - -.. _d_6d49595cea3e0fa957a06fb11bda4897: - -ResourceGetDto0 Model Structure -------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - elements | No | string | | | - name | No | string | | | - parentId | No | string | | | - resourceId | Yes | string | | | Resource ID - resourcePoolId | No | string | | | - resourceTypeId | No | string | | | - -.. _d_bb8426c45d4d19dc6128fbb298c7bb4d: - -ResourceGetDto1 Model Structure -------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - children | No | array of :ref:`ResourceGetDto0 ` | | | - description | No | string | | | - elements | No | string | | | - name | No | string | | | - parentId | No | string | | | - resourceId | Yes | string | | | Resource ID - resourcePoolId | No | string | | | - resourceTypeId | No | string | | | - -.. _d_958dd46196a624722ba9ea3ea4d27e38: - -ResourceGetDto2 Model Structure -------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - children | No | array of :ref:`ResourceGetDto1 ` | | | - description | No | string | | | - elements | No | string | | | - name | No | string | | | - parentId | No | string | | | - resourceId | Yes | string | | | Resource ID - resourcePoolId | No | string | | | - resourceTypeId | No | string | | | - -.. _d_942ff02bfe350c7d2a7f3faabf5d77d1: - -ResourceListDto Model Structure -------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - name | No | string | | | - parentId | No | string | | | - resourceId | Yes | string | | | Resource ID - resourcePoolId | No | string | | | - resourceTypeId | No | string | | | - -.. _d_296e5d50362a85c0b8843dfe38965ce9: - -ResourcePoolGetDto Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - globalLocationId | No | string | | | - location | No | string | | | - name | No | string | | | - resourcePoolId | Yes | string | | | Resource pool ID - -.. _d_fb92075f954e3895d1435d4e523666fa: - -ResourceTypeGetDto Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - description | No | string | | | - name | No | string | | | - resourceTypeId | Yes | string | | | Resource type ID - vendor | No | string | | | - version | No | string | | | - -.. _d_18b723a8578a1c0bdb13e962c902ad95: - -SmoEndpointCreateDto Model Structure ------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - endpoint | Yes | string | | | Configuration SMO callback address - -.. _d_36a34be9221cecc9bf82d276b9266961: - -SmoEndpointCreatedRespDto Model Structure ------------------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - id | Yes | string | | | SMO Endpoint Configuration ID - -.. _d_a6b61d9695be919cc22b2e700eeb7e27: - -SmoEndpointGetDto Model Structure ---------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - comments | No | string | | | - endpoint | No | string | | | - id | Yes | string | | | SMO Endpoint Configuration ID - status | No | string | | | - -.. _d_0fff8519707c32c34f86d6ac19fad343: - -SubscriptionCreateDto Model Structure -------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - callback | Yes | string | | | Subscription callback address - consumerSubscriptionId | No | string | | | - filter | No | string | | | - -.. _d_4397329931bf78862bc91387dbdb86c4: - -SubscriptionCreatedRespDto Model Structure ------------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - subscriptionId | Yes | string | | | Subscription ID - -.. _d_90e532f740e7ec8e9d71fad08513c388: - -SubscriptionGetDto Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - callback | No | string | | | - consumerSubscriptionId | No | string | | | - filter | No | string | | | - subscriptionId | Yes | string | | | Subscription ID - diff --git a/docs/conf.py b/docs/conf.py index 922e22f..93ba0c4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,37 @@ +# Copyright (C) 2022 Wind River Systems, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. from docs_conf.conf import * + linkcheck_ignore = [ 'http://localhost.*', 'http://127.0.0.1.*', - 'https://gerrit.o-ran-sc.org.*' + 'https://gerrit.o-ran-sc.org.*', + './oran-o2-api.html' # Generated file that doesn't exist at link check. ] + +extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx'] + +redoc = [ + { + 'name': 'O-RAN O2 API', + 'page': 'oran-o2-api', + 'spec': './swagger.json', + 'embed': True, + } +] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + +# intershpinx mapping with other projects +# intersphinx_mapping = {} diff --git a/docs/images/swagger.png b/docs/images/swagger.png new file mode 100755 index 0000000..f5a9e0c Binary files /dev/null and b/docs/images/swagger.png differ diff --git a/docs/images/yaml_logo.png b/docs/images/yaml_logo.png new file mode 100755 index 0000000..0492eb4 Binary files /dev/null and b/docs/images/yaml_logo.png differ diff --git a/docs/index.rst b/docs/index.rst index b24169b..41f031b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,6 @@ Welcome to INF O2 documentation release-notes.rst installation-guide.rst user-guide.rst - api.rst + api-docs.rst * :ref:`search` diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 5d3a810..28c9f92 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -2,5 +2,10 @@ sphinx sphinx-rtd-theme>=1.0.0 docutils<0.17 sphinxcontrib-httpdomain +sphinxcontrib-redoc +sphinxcontrib-needs +sphinxcontrib-swaggerdoc +sphinx_bootstrap_theme +sphinx_rtd_theme recommonmark -lfdocs-conf +lfdocs-conf \ No newline at end of file diff --git a/docs/swagger.json b/docs/swagger.json new file mode 100644 index 0000000..bbdefbb --- /dev/null +++ b/docs/swagger.json @@ -0,0 +1,1611 @@ +{ + "swagger": "2.0", + "basePath": "/", + "paths": { + "/o2ims-infrastructureInventory/api_versions": { + "get": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "get_inventory_version", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "oCloud not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OcloudDto" + } + } + }, + "operationId": "get_oclouds_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "oCloud not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OcloudDto" + } + } + }, + "operationId": "get_oclouds_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/api_versions": { + "get": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "get_version_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/deploymentManagers": { + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentManagerListDto" + } + } + } + }, + "operationId": "get_deployment_managers_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "in": "query", + "description": "DMS profile: value supports \"native_k8sapi\"", + "name": "profile", + "type": "string" + }, + { + "in": "path", + "description": "ID of the deployment manager", + "name": "deploymentManagerID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Deployment manager not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentManagerGetDto" + } + } + }, + "operationId": "Get deployment manager", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourcePools": { + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourcePoolGetDto" + } + } + } + }, + "operationId": "get_resource_pools_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "in": "path", + "description": "ID of the resource pool", + "name": "resourcePoolID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Resource pool not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourcePoolGetDto" + } + } + }, + "operationId": "Get resource pool", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources": { + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + }, + { + "in": "path", + "description": "ID of the resource pool", + "name": "resourcePoolID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Resource pool not found" + }, + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceListDto" + } + } + } + }, + "operationId": "get_resources_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "in": "path", + "description": "ID of the resource", + "name": "resourceID", + "required": true, + "type": "string" + }, + { + "in": "path", + "description": "ID of the resource pool", + "name": "resourcePoolID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Resource not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceGetDto2" + } + } + }, + "operationId": "Get resource", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourceTypes": { + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeGetDto" + } + } + } + }, + "operationId": "get_resource_types_list_router", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "in": "path", + "description": "ID of the resource type", + "name": "resourceTypeID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Resource type not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceTypeGetDto" + } + } + }, + "operationId": "Get resource type", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/subscriptions": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionGetDto" + } + } + } + }, + "operationId": "List subscriptions", + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "tags": [ + "O2IMS_Inventory" + ] + }, + "post": { + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SubscriptionGetDto" + } + } + }, + "operationId": "Create a subscription", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SubscriptionCreateDto" + } + } + ], + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}": { + "parameters": [ + { + "in": "path", + "description": "ID of the subscription", + "name": "subscriptionID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Subscription not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SubscriptionGetDto" + } + } + }, + "operationId": "Get subscription by ID", + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + } + ], + "tags": [ + "O2IMS_Inventory" + ] + }, + "delete": { + "responses": { + "404": { + "description": "Subscription not found" + }, + "200": { + "description": "Subscription deleted" + } + }, + "operationId": "Delete subscription by ID", + "tags": [ + "O2IMS_Inventory" + ] + } + }, + "/o2ims-infrastructureMonitoring/api_versions": { + "get": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "get_monitoring_version", + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + }, + "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": { + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AlarmSubscriptionGetDto" + } + } + } + }, + "operationId": "List alarm subscriptions", + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + }, + "post": { + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AlarmSubscriptionGetDto" + } + } + }, + "operationId": "Create a alarm subscription", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/AlarmSubscriptionCreateDto" + } + } + ], + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + }, + "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}": { + "parameters": [ + { + "in": "path", + "description": "ID of the Alarm Subscription", + "name": "alarmSubscriptionID", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Alarm Subscription not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AlarmSubscriptionGetDto" + } + } + }, + "operationId": "Get Alarm Subscription by ID", + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + } + ], + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + }, + "delete": { + "responses": { + "404": { + "description": "Alarm Subscription not found" + }, + "200": { + "description": "Subscription deleted" + } + }, + "operationId": "Delete subscription by ID", + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + }, + "/o2ims-infrastructureMonitoring/v1/alarms": { + "parameters": [ + { + "in": "query", + "description": "Filter of the query.", + "name": "filter", + "type": "string" + }, + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "default": 1, + "in": "query", + "description": "Page number of the results to fetch. Default: 1", + "name": "nextpage_opaque_marker", + "type": "string" + } + ], + "get": { + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AlarmGetDto" + } + } + } + }, + "operationId": "get_alarm_list_router", + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + }, + "/o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}": { + "parameters": [ + { + "in": "query", + "description": "Exclude showing all default fields, Set \"true\" to enable.", + "name": "exclude_default", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".", + "name": "exclude_fields", + "type": "string" + }, + { + "in": "query", + "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".", + "name": "fields", + "type": "string" + }, + { + "in": "query", + "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".", + "name": "all_fields", + "type": "string" + }, + { + "in": "path", + "description": "ID of the alarm event record", + "name": "alarmEventRecordId", + "required": true, + "type": "string" + } + ], + "get": { + "responses": { + "404": { + "description": "Alarm Event Record not found" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AlarmGetDto" + } + } + }, + "operationId": "Get AlarmEventRecord", + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + }, + "/o2ims-infrastructureMonitoring/v1/api_versions": { + "get": { + "responses": { + "200": { + "description": "Success" + } + }, + "operationId": "get_version_router", + "tags": [ + "O2IMS_InfrastructureMonitoring" + ] + } + } + }, + "info": { + "title": "INF O2 Services API", + "version": "1.0.0", + "description": "Swagger OpenAPI document for the INF O2 Services" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "tags": [ + { + "name": "O2IMS_Inventory", + "description": "IMS Inventory related operations." + }, + { + "name": "O2IMS_InfrastructureMonitoring", + "description": "O2 IMS Monitoring related operations." + } + ], + "definitions": { + "OcloudDto": { + "required": [ + "oCloudId" + ], + "properties": { + "oCloudId": { + "type": "string" + }, + "globalCloudId": { + "type": "string" + }, + "globalcloudId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "serviceUri": { + "type": "string" + }, + "extensions": { + "type": "string" + } + }, + "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}", + "type": "object" + }, + "ResourceTypeGetDto": { + "required": [ + "resourceTypeId" + ], + "properties": { + "resourceTypeId": { + "type": "string", + "description": "Resource type ID" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "model": { + "type": "string" + }, + "version": { + "type": "string" + }, + "alarmDictionary": { + "$ref": "#/definitions/AlarmDictionaryDto" + }, + "extensions": { + "type": "string" + } + }, + "x-mask": "{resourceTypeId,name,description,model,vendor,version}", + "type": "object" + }, + "AlarmDictionaryDto": { + "properties": { + "id": { + "type": "string" + }, + "alarmDictionaryVersion": { + "type": "string" + }, + "alarmDictionarySchemaVersion": { + "type": "string" + }, + "entityType": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "managementInterfaceId": { + "type": "string" + }, + "pkNotificationField": { + "type": "string" + }, + "alarmDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/AlarmDefinitionDto" + } + } + }, + "type": "object" + }, + "AlarmDefinitionDto": { + "properties": { + "alarmDefinitionId": { + "type": "string" + }, + "alarmName": { + "type": "string" + }, + "alarmLastChange": { + "type": "string" + }, + "alarmChangeType": { + "type": "string" + }, + "alarmDescription": { + "type": "string" + }, + "proposedRepairActions": { + "type": "string" + }, + "clearingType": { + "type": "string" + }, + "managementInterfaceId": { + "type": "string" + }, + "pkNotificationField": { + "type": "string" + }, + "alarmAdditionalFields": { + "type": "string" + } + }, + "type": "object" + }, + "ResourcePoolGetDto": { + "required": [ + "resourcePoolId" + ], + "properties": { + "resourcePoolId": { + "type": "string", + "description": "Resource pool ID" + }, + "globalLocationId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "oCloudId": { + "type": "string" + }, + "location": { + "type": "string" + }, + "extensions": { + "type": "string" + } + }, + "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}", + "type": "object" + }, + "ResourceListDto": { + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "Resource ID" + }, + "resourceTypeId": { + "type": "string" + }, + "resourcePoolId": { + "type": "string" + }, + "globalAssetId": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "description": { + "type": "string" + }, + "extensions": { + "type": "object" + } + }, + "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}", + "type": "object" + }, + "ResourceGetDto2": { + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "Resource ID" + }, + "resourceTypeId": { + "type": "string" + }, + "resourcePoolId": { + "type": "string" + }, + "globalAssetId": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "description": { + "type": "string" + }, + "extensions": { + "type": "object" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGetDto1" + } + } + }, + "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}", + "type": "object" + }, + "ResourceGetDto1": { + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "Resource ID" + }, + "resourceTypeId": { + "type": "string" + }, + "resourcePoolId": { + "type": "string" + }, + "globalAssetId": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "description": { + "type": "string" + }, + "extensions": { + "type": "object" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGetDto0" + } + } + }, + "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}", + "type": "object" + }, + "ResourceGetDto0": { + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "Resource ID" + }, + "resourceTypeId": { + "type": "string" + }, + "resourcePoolId": { + "type": "string" + }, + "globalAssetId": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "description": { + "type": "string" + }, + "extensions": { + "type": "object" + } + }, + "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}", + "type": "object" + }, + "DeploymentManagerListDto": { + "required": [ + "deploymentManagerId" + ], + "properties": { + "deploymentManagerId": { + "type": "string", + "description": "Deployment manager ID" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "oCloudId": { + "type": "string" + }, + "serviceUri": { + "type": "string" + }, + "profileSupportList": { + "type": "array", + "description": "Profile support list, use default for the return endpoint", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "string" + } + }, + "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}", + "type": "object" + }, + "DeploymentManagerGetDto": { + "required": [ + "deploymentManagerId" + ], + "properties": { + "deploymentManagerId": { + "type": "string", + "description": "Deployment manager ID" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "oCloudId": { + "type": "string" + }, + "serviceUri": { + "type": "string" + }, + "extensions": { + "$ref": "#/definitions/DeploymentManagerExtensions" + } + }, + "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}", + "type": "object" + }, + "DeploymentManagerExtensions": { + "properties": { + "profileName": { + "type": "string" + }, + "profileData": { + "$ref": "#/definitions/DeploymentManagerGetDtoProfile" + } + }, + "type": "object" + }, + "DeploymentManagerGetDtoProfile": { + "properties": { + "cluster_api_endpoint": { + "type": "string" + }, + "cluster_ca_cert": { + "type": "string" + }, + "admin_user": { + "type": "string" + }, + "admin_client_cert": { + "type": "string" + }, + "admin_client_key": { + "type": "string" + }, + "helmcli_host_with_port": { + "type": "string" + }, + "helmcli_username": { + "type": "string" + }, + "helmcli_password": { + "type": "string" + }, + "helmcli_kubeconfig": { + "type": "string" + } + }, + "type": "object" + }, + "SubscriptionCreateDto": { + "required": [ + "callback" + ], + "properties": { + "callback": { + "type": "string", + "description": "Subscription callback address" + }, + "consumerSubscriptionId": { + "type": "string" + }, + "filter": { + "type": "string" + } + }, + "type": "object" + }, + "SubscriptionGetDto": { + "required": [ + "subscriptionId" + ], + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID" + }, + "callback": { + "type": "string" + }, + "consumerSubscriptionId": { + "type": "string" + }, + "filter": { + "type": "string" + } + }, + "x-mask": "{subscriptionId,callback}", + "type": "object" + }, + "AlarmGetDto": { + "required": [ + "alarmEventRecordId" + ], + "properties": { + "alarmEventRecordId": { + "type": "string", + "description": "Alarm Event Record ID" + }, + "resourceTypeId": { + "type": "string" + }, + "resourceTypeID": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "resourceID": { + "type": "string" + }, + "alarmDefinitionId": { + "type": "string" + }, + "alarmDefinitionID": { + "type": "string" + }, + "probableCauseId": { + "type": "string" + }, + "probableCauseID": { + "type": "string" + }, + "alarmRaisedTime": { + "type": "string" + }, + "alarmChangedTime": { + "type": "string" + }, + "alarmAcknowledgeTime": { + "type": "string" + }, + "alarmAcknowledged": { + "type": "boolean" + }, + "perceivedSeverity": { + "type": "string" + }, + "extensions": { + "type": "object" + } + }, + "type": "object" + }, + "AlarmSubscriptionCreateDto": { + "required": [ + "callback" + ], + "properties": { + "callback": { + "type": "string", + "description": "Alarm Subscription callback address" + }, + "consumerSubscriptionId": { + "type": "string" + }, + "filter": { + "type": "string" + } + }, + "type": "object" + }, + "AlarmSubscriptionGetDto": { + "required": [ + "alarmSubscriptionId" + ], + "properties": { + "alarmSubscriptionId": { + "type": "string", + "description": "Alarm Subscription ID" + }, + "callback": { + "type": "string" + }, + "consumerSubscriptionId": { + "type": "string" + }, + "filter": { + "type": "string" + } + }, + "x-mask": "{alarmSubscriptionId,callback}", + "type": "object" + } + }, + "responses": { + "ParseError": { + "description": "When a mask can't be parsed" + }, + "MaskError": { + "description": "When any error occurs on mask" + }, + "HTTPException": { + "description": "Default error handler" + }, + "NotFound": { + "description": "notfound handler" + }, + "BadRequestException": { + "description": "Return a custom message and 400 status code" + }, + "NotFoundException": { + "description": "Return a custom message and 404 status code" + }, + "MethodNotAllowed": { + "description": "Return a custom message and 405 status code" + }, + "InternalServerError": { + "description": "Return a custom message and 500 status code" + }, + "Exception": { + "description": "Return a custom message and 500 status code" + } + } +} \ No newline at end of file diff --git a/docs/swagger.yaml b/docs/swagger.yaml new file mode 100755 index 0000000..fa0e624 --- /dev/null +++ b/docs/swagger.yaml @@ -0,0 +1,1156 @@ +--- +swagger: "2.0" +info: + description: Swagger OpenAPI document for the INF O2 Services + version: 1.0.0 + title: INF O2 Services API +basePath: / +tags: +- name: O2IMS_Inventory + description: IMS Inventory related operations. +- name: O2IMS_InfrastructureMonitoring + description: O2 IMS Monitoring related operations. +consumes: +- application/json +produces: +- application/json +paths: + /o2ims-infrastructureInventory/api_versions: + get: + tags: + - O2IMS_Inventory + operationId: get_inventory_version + parameters: [] + responses: + "200": + description: Success + /o2ims-infrastructureInventory/v1: + get: + tags: + - O2IMS_Inventory + operationId: get_oclouds_list_router + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/OcloudDto' + "404": + description: oCloud not found + /o2ims-infrastructureInventory/v1/: + get: + tags: + - O2IMS_Inventory + operationId: get_oclouds_list_router + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/OcloudDto' + "404": + description: oCloud not found + /o2ims-infrastructureInventory/v1/api_versions: + get: + tags: + - O2IMS_Inventory + operationId: get_version_router + parameters: [] + responses: + "200": + description: Success + /o2ims-infrastructureInventory/v1/deploymentManagers: + get: + tags: + - O2IMS_Inventory + operationId: get_deployment_managers_list_router + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/DeploymentManagerListDto' + /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}: + get: + tags: + - O2IMS_Inventory + operationId: Get deployment manager + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: profile + in: query + description: "DMS profile: value supports \"native_k8sapi\"" + required: false + type: string + - name: deploymentManagerID + in: path + description: ID of the deployment manager + required: true + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/DeploymentManagerGetDto' + "404": + description: Deployment manager not found + /o2ims-infrastructureInventory/v1/resourcePools: + get: + tags: + - O2IMS_Inventory + operationId: get_resource_pools_list_router + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/ResourcePoolGetDto' + /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}: + get: + tags: + - O2IMS_Inventory + operationId: Get resource pool + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: resourcePoolID + in: path + description: ID of the resource pool + required: true + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/ResourcePoolGetDto' + "404": + description: Resource pool not found + /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources: + get: + tags: + - O2IMS_Inventory + operationId: get_resources_list_router + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + - name: resourcePoolID + in: path + description: ID of the resource pool + required: true + type: string + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/ResourceListDto' + "404": + description: Resource pool not found + /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}: + get: + tags: + - O2IMS_Inventory + operationId: Get resource + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: resourceID + in: path + description: ID of the resource + required: true + type: string + - name: resourcePoolID + in: path + description: ID of the resource pool + required: true + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/ResourceGetDto2' + "404": + description: Resource not found + /o2ims-infrastructureInventory/v1/resourceTypes: + get: + tags: + - O2IMS_Inventory + operationId: get_resource_types_list_router + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/ResourceTypeGetDto' + /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}: + get: + tags: + - O2IMS_Inventory + operationId: Get resource type + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: resourceTypeID + in: path + description: ID of the resource type + required: true + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/ResourceTypeGetDto' + "404": + description: Resource type not found + /o2ims-infrastructureInventory/v1/subscriptions: + get: + tags: + - O2IMS_Inventory + operationId: List subscriptions + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/SubscriptionGetDto' + post: + tags: + - O2IMS_Inventory + operationId: Create a subscription + parameters: + - in: body + name: payload + required: true + schema: + $ref: '#/definitions/SubscriptionCreateDto' + responses: + "201": + description: Success + schema: + $ref: '#/definitions/SubscriptionGetDto' + /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}: + get: + tags: + - O2IMS_Inventory + operationId: Get subscription by ID + parameters: + - name: subscriptionID + in: path + description: ID of the subscription + required: true + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/SubscriptionGetDto' + "404": + description: Subscription not found + delete: + tags: + - O2IMS_Inventory + operationId: Delete subscription by ID + parameters: + - name: subscriptionID + in: path + description: ID of the subscription + required: true + type: string + responses: + "200": + description: Subscription deleted + "404": + description: Subscription not found + /o2ims-infrastructureMonitoring/api_versions: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: get_monitoring_version + parameters: [] + responses: + "200": + description: Success + /o2ims-infrastructureMonitoring/v1/alarmSubscriptions: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: List alarm subscriptions + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/AlarmSubscriptionGetDto' + post: + tags: + - O2IMS_InfrastructureMonitoring + operationId: Create a alarm subscription + parameters: + - in: body + name: payload + required: true + schema: + $ref: '#/definitions/AlarmSubscriptionCreateDto' + responses: + "201": + description: Success + schema: + $ref: '#/definitions/AlarmSubscriptionGetDto' + /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: Get Alarm Subscription by ID + parameters: + - name: alarmSubscriptionID + in: path + description: ID of the Alarm Subscription + required: true + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/AlarmSubscriptionGetDto' + "404": + description: Alarm Subscription not found + delete: + tags: + - O2IMS_InfrastructureMonitoring + operationId: Delete subscription by ID + parameters: + - name: alarmSubscriptionID + in: path + description: ID of the Alarm Subscription + required: true + type: string + responses: + "200": + description: Subscription deleted + "404": + description: Alarm Subscription not found + /o2ims-infrastructureMonitoring/v1/alarms: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: get_alarm_list_router + parameters: + - name: filter + in: query + description: Filter of the query. + required: false + type: string + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: nextpage_opaque_marker + in: query + description: "Page number of the results to fetch. Default: 1" + required: false + type: string + default: "1" + responses: + "200": + description: Success + schema: + type: array + items: + $ref: '#/definitions/AlarmGetDto' + /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: Get AlarmEventRecord + parameters: + - name: exclude_default + in: query + description: "Exclude showing all default fields, Set \"true\" to enable." + required: false + type: string + - name: exclude_fields + in: query + description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"." + required: false + type: string + - name: fields + in: query + description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"." + required: false + type: string + - name: all_fields + in: query + description: Set any value for show all fields. This value will cover "fields" and "all_fields". + required: false + type: string + - name: alarmEventRecordId + in: path + description: ID of the alarm event record + required: true + type: string + responses: + "200": + description: Success + schema: + $ref: '#/definitions/AlarmGetDto' + "404": + description: Alarm Event Record not found + /o2ims-infrastructureMonitoring/v1/api_versions: + get: + tags: + - O2IMS_InfrastructureMonitoring + operationId: get_version_router + parameters: [] + responses: + "200": + description: Success +definitions: + OcloudDto: + type: object + required: + - oCloudId + properties: + oCloudId: + type: string + globalCloudId: + type: string + globalcloudId: + type: string + name: + type: string + description: + type: string + serviceUri: + type: string + extensions: + type: string + x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}" + ResourceTypeGetDto: + type: object + required: + - resourceTypeId + properties: + resourceTypeId: + type: string + description: Resource type ID + name: + type: string + description: + type: string + vendor: + type: string + model: + type: string + version: + type: string + alarmDictionary: + $ref: '#/definitions/AlarmDictionaryDto' + extensions: + type: string + x-mask: "{resourceTypeId,name,description,model,vendor,version}" + AlarmDictionaryDto: + type: object + properties: + id: + type: string + alarmDictionaryVersion: + type: string + alarmDictionarySchemaVersion: + type: string + entityType: + type: string + vendor: + type: string + managementInterfaceId: + type: string + pkNotificationField: + type: string + alarmDefinition: + type: array + items: + $ref: '#/definitions/AlarmDefinitionDto' + AlarmDefinitionDto: + type: object + properties: + alarmDefinitionId: + type: string + alarmName: + type: string + alarmLastChange: + type: string + alarmChangeType: + type: string + alarmDescription: + type: string + proposedRepairActions: + type: string + clearingType: + type: string + managementInterfaceId: + type: string + pkNotificationField: + type: string + alarmAdditionalFields: + type: string + ResourcePoolGetDto: + type: object + required: + - resourcePoolId + properties: + resourcePoolId: + type: string + description: Resource pool ID + globalLocationId: + type: string + name: + type: string + description: + type: string + oCloudId: + type: string + location: + type: string + extensions: + type: string + x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}" + ResourceListDto: + type: object + required: + - resourceId + properties: + resourceId: + type: string + description: Resource ID + resourceTypeId: + type: string + resourcePoolId: + type: string + globalAssetId: + type: string + parentId: + type: string + description: + type: string + extensions: + type: object + properties: {} + x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}" + ResourceGetDto2: + type: object + required: + - resourceId + properties: + resourceId: + type: string + description: Resource ID + resourceTypeId: + type: string + resourcePoolId: + type: string + globalAssetId: + type: string + parentId: + type: string + description: + type: string + extensions: + type: object + properties: {} + elements: + type: array + items: + $ref: '#/definitions/ResourceGetDto1' + x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}" + ResourceGetDto1: + type: object + required: + - resourceId + properties: + resourceId: + type: string + description: Resource ID + resourceTypeId: + type: string + resourcePoolId: + type: string + globalAssetId: + type: string + parentId: + type: string + description: + type: string + extensions: + type: object + properties: {} + elements: + type: array + items: + $ref: '#/definitions/ResourceGetDto0' + x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}" + ResourceGetDto0: + type: object + required: + - resourceId + properties: + resourceId: + type: string + description: Resource ID + resourceTypeId: + type: string + resourcePoolId: + type: string + globalAssetId: + type: string + parentId: + type: string + description: + type: string + extensions: + type: object + properties: {} + x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}" + DeploymentManagerListDto: + type: object + required: + - deploymentManagerId + properties: + deploymentManagerId: + type: string + description: Deployment manager ID + name: + type: string + description: + type: string + oCloudId: + type: string + serviceUri: + type: string + profileSupportList: + type: array + description: "Profile support list, use default for the return endpoint" + items: + type: string + extensions: + type: string + x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}" + DeploymentManagerGetDto: + type: object + required: + - deploymentManagerId + properties: + deploymentManagerId: + type: string + description: Deployment manager ID + name: + type: string + description: + type: string + oCloudId: + type: string + serviceUri: + type: string + extensions: + $ref: '#/definitions/DeploymentManagerExtensions' + x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}" + DeploymentManagerExtensions: + type: object + properties: + profileName: + type: string + profileData: + $ref: '#/definitions/DeploymentManagerGetDtoProfile' + DeploymentManagerGetDtoProfile: + type: object + properties: + cluster_api_endpoint: + type: string + cluster_ca_cert: + type: string + admin_user: + type: string + admin_client_cert: + type: string + admin_client_key: + type: string + helmcli_host_with_port: + type: string + helmcli_username: + type: string + helmcli_password: + type: string + helmcli_kubeconfig: + type: string + SubscriptionCreateDto: + type: object + required: + - callback + properties: + callback: + type: string + description: Subscription callback address + consumerSubscriptionId: + type: string + filter: + type: string + SubscriptionGetDto: + type: object + required: + - subscriptionId + properties: + subscriptionId: + type: string + description: Subscription ID + callback: + type: string + consumerSubscriptionId: + type: string + filter: + type: string + x-mask: "{subscriptionId,callback}" + AlarmGetDto: + type: object + required: + - alarmEventRecordId + properties: + alarmEventRecordId: + type: string + description: Alarm Event Record ID + resourceTypeId: + type: string + resourceTypeID: + type: string + resourceId: + type: string + resourceID: + type: string + alarmDefinitionId: + type: string + alarmDefinitionID: + type: string + probableCauseId: + type: string + probableCauseID: + type: string + alarmRaisedTime: + type: string + alarmChangedTime: + type: string + alarmAcknowledgeTime: + type: string + alarmAcknowledged: + type: boolean + perceivedSeverity: + type: string + extensions: + type: object + properties: {} + AlarmSubscriptionCreateDto: + type: object + required: + - callback + properties: + callback: + type: string + description: Alarm Subscription callback address + consumerSubscriptionId: + type: string + filter: + type: string + AlarmSubscriptionGetDto: + type: object + required: + - alarmSubscriptionId + properties: + alarmSubscriptionId: + type: string + description: Alarm Subscription ID + callback: + type: string + consumerSubscriptionId: + type: string + filter: + type: string + x-mask: "{alarmSubscriptionId,callback}" +responses: + ParseError: + description: When a mask can't be parsed + MaskError: + description: When any error occurs on mask + HTTPException: + description: Default error handler + NotFound: + description: notfound handler + BadRequestException: + description: Return a custom message and 400 status code + NotFoundException: + description: Return a custom message and 404 status code + MethodNotAllowed: + description: Return a custom message and 405 status code + InternalServerError: + description: Return a custom message and 500 status code + Exception: + description: Return a custom message and 500 status code diff --git a/tox.ini b/tox.ini index 9eef538..1b6cb1c 100644 --- a/tox.ini +++ b/tox.ini @@ -49,12 +49,7 @@ commands = [testenv:docs] basepython = python3 -deps = - sphinx - sphinx-rtd-theme - sphinxcontrib-httpdomain - recommonmark - lfdocs-conf +deps = -r{toxinidir}/docs/requirements-docs.txt commands = sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html @@ -65,9 +60,6 @@ whitelist_externals = echo [testenv:docs-linkcheck] basepython = python3 -deps = sphinx - sphinx-rtd-theme - sphinxcontrib-httpdomain - recommonmark - lfdocs-conf +deps = -r{toxinidir}/docs/requirements-docs.txt + commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck