Create primary documentation for Jakarta release

* Update release notes
* Update openapi documentation

Issue-ID: CPS-935
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
Change-Id: If63ee52efa505694010c88f3135a71312185b4dc

diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml
index 300557b..59e1021 100644 (file)
--- a/docs/api/swagger/openapi.yaml
+++ b/docs/api/swagger/openapi.yaml
@@ -4,29 +4,29 @@ info:
   description: Adds Data Model Inventory Registry capability for ONAP
   version: 1.0.0
 servers:
-  - url: /dmi
+- url: /dmi
 tags:
-  - name: dmi-plugin-internal
-    description: DMI plugin internal rest apis
-  - name: dmi-plugin
-    description: DMI plugin rest apis
+- name: dmi-plugin-internal
+  description: DMI plugin internal rest apis
+- name: dmi-plugin
+  description: DMI plugin rest apis
 paths:
   /v1/ch/{cmHandle}/modules:
     post:
       tags:
-        - dmi-plugin
+      - dmi-plugin
       summary: Get all modules for cm handle
       description: Get all modules for given cm handle
       operationId: getModuleReferences
       parameters:
-        - name: cmHandle
-          in: path
-          description: The identifier for a network function, network element, subnetwork,
-            or any other cm object by managed Network CM Proxy
-          required: true
-          schema:
-            type: string
-            example: my-cm-handle
+      - name: cmHandle
+        in: path
+        description: The identifier for a network function, network element, subnetwork,
+          or any other cm object by managed Network CM Proxy
+        required: true
+        schema:
+          type: string
+          example: my-cm-handle
       requestBody:
         description: Operational body
         content:
@@ -63,19 +63,19 @@ paths:
   /v1/ch/{cmHandle}/moduleResources:
     post:
       tags:
-        - dmi-plugin
+      - dmi-plugin
       summary: Retrieve module resources
       description: Retrieve module resources for one or more modules
       operationId: retrieveModuleResources
       parameters:
-        - name: cmHandle
-          in: path
-          description: The identifier for a network function, network element, subnetwork,
-            or any other cm object by managed Network CM Proxy
-          required: true
-          schema:
-            type: string
-            example: my-cm-handle
+      - name: cmHandle
+        in: path
+        description: The identifier for a network function, network element, subnetwork,
+          or any other cm object by managed Network CM Proxy
+        required: true
+        schema:
+          type: string
+          example: my-cm-handle
       requestBody:
         content:
           application/json:
@@ -112,7 +112,7 @@ paths:
   /v1/inventory/cmHandles:
     post:
       tags:
-        - dmi-plugin-internal
+      - dmi-plugin-internal
       summary: register given list of cm handles (internal use only)
       description: register given list of cm handles (internal use only)
       operationId: registerCmHandles
@@ -155,55 +155,55 @@ paths:
   /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational:
     post:
       tags:
-        - dmi-plugin
+      - dmi-plugin
       summary: Get resource data from passthrough-operational for cm handle
       description: Get resource data from passthrough-operational for cm handle. Will
         support read operations only.
       operationId: dataAccessPassthroughOperational
       parameters:
-        - name: cmHandle
-          in: path
-          description: The identifier for a network function, network element, subnetwork,
-            or any other cm object by managed Network CM Proxy
-          required: true
-          schema:
-            type: string
-            example: my-cm-handle
-        - name: resourceIdentifier
-          in: query
-          description: Resource identifier to get/set the resource data
-          required: true
-          allowReserved: true
-          schema:
-            type: string
-            example: my-schema:my-node
-        - name: accept
-          in: header
-          description: Accept parameter for response, if accept parameter is null, that
-            means client can accept any format.
-          schema:
-            type: string
-            enum:
-              - application/json
-              - application/yang-data+json
-        - name: options
-          in: query
-          description: options parameter in query, it is mandatory to wrap key(s)=value(s)
-            in parenthesis'()'.
-          required: false
-          allowReserved: true
-          schema:
-            type: string
-          examples:
-            sample1:
-              value:
-                options: (key1=value1,key2=value2)
-            sample2:
-              value:
-                options: (key1=value1,key2=value1/value2)
-            sample3:
-              value:
-                options: (key1=10,key2=value2,key3=val31,val32)
+      - name: cmHandle
+        in: path
+        description: The identifier for a network function, network element, subnetwork,
+          or any other cm object by managed Network CM Proxy
+        required: true
+        schema:
+          type: string
+          example: my-cm-handle
+      - name: resourceIdentifier
+        in: query
+        description: Resource identifier to get/set the resource data
+        required: true
+        allowReserved: true
+        schema:
+          type: string
+          example: my-schema:my-node
+      - name: accept
+        in: header
+        description: Accept parameter for response, if accept parameter is null, that
+          means client can accept any format.
+        schema:
+          type: string
+          enum:
+          - application/json
+          - application/yang-data+json
+      - name: options
+        in: query
+        description: options parameter in query, it is mandatory to wrap key(s)=value(s)
+          in parenthesis'()'.
+        required: false
+        allowReserved: true
+        schema:
+          type: string
+        examples:
+          sample1:
+            value:
+              options: (key1=value1,key2=value2)
+          sample2:
+            value:
+              options: (key1=value1,key2=value1/value2)
+          sample3:
+            value:
+              options: (key1=10,key2=value2,key3=val31,val32)
       requestBody:
         description: Operational body
         content:
@@ -218,9 +218,9 @@ paths:
               schema:
                 type: object
                 example:
-                  - yangSource: my-yang-source
-                    moduleName: my-module-name
-                    revision: my-revision
+                - yangSource: my-yang-source
+                  moduleName: my-module-name
+                  revision: my-revision
         "400":
           description: Bad Request
           content:
@@ -244,7 +244,7 @@ paths:
   /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running:
     post:
       tags:
-        - dmi-plugin
+      - dmi-plugin
       summary: Get, Create or Update request for data passthrough-running for a cm-handle
       description: Post request to Get, Create or to Update resource data for a cm-handle.
         Since all requests need to include additional information in a request body
@@ -252,49 +252,49 @@ paths:
         the request body instead.
       operationId: dataAccessPassthroughRunning
       parameters:
-        - name: cmHandle
-          in: path
-          description: The identifier for a network function, network element, subnetwork,
-            or any other cm object by managed Network CM Proxy
-          required: true
-          schema:
-            type: string
-            example: my-cm-handle
-        - name: resourceIdentifier
-          in: query
-          description: Resource identifier to get/set the resource data
-          required: true
-          allowReserved: true
-          schema:
-            type: string
-            example: my-schema:my-node
-        - name: accept
-          in: header
-          description: Accept parameter for response, if accept parameter is null, that
-            means client can accept any format.
-          schema:
-            type: string
-            enum:
-              - application/json
-              - application/yang-data+json
-        - name: options
-          in: query
-          description: options parameter in query, it is mandatory to wrap key(s)=value(s)
-            in parenthesis'()'.
-          required: false
-          allowReserved: true
-          schema:
-            type: string
-          examples:
-            sample1:
-              value:
-                options: (key1=value1,key2=value2)
-            sample2:
-              value:
-                options: (key1=value1,key2=value1/value2)
-            sample3:
-              value:
-                options: (key1=10,key2=value2,key3=val31,val32)
+      - name: cmHandle
+        in: path
+        description: The identifier for a network function, network element, subnetwork,
+          or any other cm object by managed Network CM Proxy
+        required: true
+        schema:
+          type: string
+          example: my-cm-handle
+      - name: resourceIdentifier
+        in: query
+        description: Resource identifier to get/set the resource data
+        required: true
+        allowReserved: true
+        schema:
+          type: string
+          example: my-schema:my-node
+      - name: accept
+        in: header
+        description: Accept parameter for response, if accept parameter is null, that
+          means client can accept any format.
+        schema:
+          type: string
+          enum:
+          - application/json
+          - application/yang-data+json
+      - name: options
+        in: query
+        description: options parameter in query, it is mandatory to wrap key(s)=value(s)
+          in parenthesis'()'.
+        required: false
+        allowReserved: true
+        schema:
+          type: string
+        examples:
+          sample1:
+            value:
+              options: (key1=value1,key2=value2)
+          sample2:
+            value:
+              options: (key1=value1,key2=value1/value2)
+          sample3:
+            value:
+              options: (key1=10,key2=value2,key3=val31,val32)
       requestBody:
         content:
           application/json:
@@ -308,16 +308,16 @@ paths:
               schema:
                 type: object
                 example:
-                  - yangSource: my-yang-source
-                    moduleName: my-module-name
-                    revision: my-revision
+                - yangSource: my-yang-source
+                  moduleName: my-module-name
+                  revision: my-revision
         "201":
           description: Created
           content:
             text/plain:
               schema:
                 type: string
-                example: cm-handle registered successfully
+                example: my-resource
         "204":
           description: No Content
           content: {}
@@ -398,9 +398,9 @@ components:
         cmHandles:
           type: array
           example:
-            - cmHandleId1
-            - cmHandleId2
-            - cmHandleId3
+          - cmHandleId1
+          - cmHandleId2
+          - cmHandleId3
           items:
             type: string
     DataAccessRequest:
@@ -410,10 +410,11 @@ components:
           type: string
           example: read
           enum:
-            - read
-            - create
-            - update
-            - delete
+          - read
+          - create
+          - update
+          - patch
+          - delete
         dataType:
           type: string
           example: my-data-type

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 4a3d48b..e30d42a 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -18,10 +18,25 @@ DMI-Plugin Release Notes
 ..      * * *   JAKARTA   * * *
 ..      ========================
 
-Version: 1.1.0-SNAPSHOT
-=======================
+Version: 1.1.0
+==============
+
+Release Data
+------------
 
-This section lists the main changes & fixes merged into master (snapshot) version of NCMP-DMI-Plugin. This information is here to assist developers that want experiment/test using our latest code bases directly. Stability of this is not guaranteed.
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project**                      |  DMI-Plugin                                            |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images**                    |  onap/ncmp-dmi-plugin:1.1.0                            |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation**              | 1.1.0 Jakarta                                          |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Release date**                     | 2022 March 15                                          |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
 
 Features
 --------