From c1904c1ee3f1a61564e154dd81c144a23a1af66c Mon Sep 17 00:00:00 2001
From: niamhcore <niamh.core@est.tech>
Date: Mon, 11 Oct 2021 16:38:53 +0100
Subject: [PATCH] Update open api information

Issue-ID: CPS-626
Signed-off-by: niamhcore <niamh.core@est.tech>
Change-Id: I7e8171e215fe55b68580f7f7a8143edc32c62ac9
---
 docs/api/swagger/ncmp/openapi-inventory.yaml | 88 ++++++++++++++++++++++++++++
 docs/design.rst                              | 25 ++++++--
 2 files changed, 109 insertions(+), 4 deletions(-)
 create mode 100644 docs/api/swagger/ncmp/openapi-inventory.yaml

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
new file mode 100644
index 000000000..627816bf8
--- /dev/null
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -0,0 +1,88 @@
+openapi: 3.0.1
+info:
+  title: NCMP Inventory API
+  description: NCMP Inventory API
+  version: "1.0"
+servers:
+- url: /ncmpInventory
+paths:
+  /v1/ch:
+    post:
+      tags:
+      - network-cm-proxy-inventory
+      summary: DMI notifies NCMP of new CM Handles
+      description: "Register a DMI Plugin with any new, updated or removed CM Handles."
+      operationId: updateDmiPluginRegistration
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RestDmiPluginRegistration'
+        required: true
+      responses:
+        "201":
+          description: Created
+          content: {}
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorMessage'
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorMessage'
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorMessage'
+components:
+  schemas:
+    RestDmiPluginRegistration:
+      type: object
+      properties:
+        dmiPlugin:
+          type: string
+          example: onap-dmi-plugin
+        createdCmHandles:
+          type: array
+          items:
+            $ref: '#/components/schemas/RestCmHandle'
+        updatedCmHandles:
+          type: array
+          items:
+            $ref: '#/components/schemas/RestCmHandle'
+        removedCmHandles:
+          type: array
+          items:
+            type: string
+    RestCmHandle:
+      required:
+      - cmHandle
+      type: object
+      properties:
+        cmHandle:
+          type: string
+          example: cmHandle123
+        cmHandleProperties:
+          $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
+    RestCmHandleAdditionalProperties:
+      type: object
+      additionalProperties:
+        type: string
+        example: system-001
+    ErrorMessage:
+      title: Error
+      type: object
+      properties:
+        status:
+          type: string
+        message:
+          type: string
+        details:
+          type: string
diff --git a/docs/design.rst b/docs/design.rst
index ce419caed..07372b24f 100755
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -15,12 +15,29 @@ CPS Design
 Offered APIs
 ============
 
-CPS supports the public APIs listed in the link below:
+CPS supports the public APIs listed in the following sections.
+
+CPS-Core
+--------
+
+CPS-Core functionality.
 
 :download:`CPS Rest OpenApi Specification <api/swagger/cps/openapi.yaml>`
 
+CPS-NCMP
+--------
+
+XNF data access and module information.
+
 :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>`
 
+CPS-NCMP-Inventory
+------------------
+
+DMI-Plugin Inventory.
+
+:download:`CPS NCMP RestOpenApi Inventory Specification <api/swagger/ncmp/openapi-inventory.yaml>`
+
 View Offered APIs
 -----------------
 
@@ -33,15 +50,15 @@ Specification can be accessed using following URI:
 
   http://<hostname>:<port>/v3/api-docs?group=cps-docket
 
-Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core
-and CPS-NCMP using the drop down table in the top right:
+Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core, CPS-NCMP
+and CPS-NCMP-Inventory using the drop down table in the top right:
 
 .. code-block:: bash
 
   http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
 
 Consumed APIs
--------------
+=============
 
 CPS Core uses API's from the following ONAP components
 
-- 
2.16.6