Update openapi for 3.5.2

- update info.version to 3.5.2 for openapi yamls
- update read-the-docs copies of openapi docs

Issue-ID: CPS-2374
Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech>
Change-Id: I7f726f610fe8eff43e281edfe2fc6d9b08f5fc15

diff --git a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
index d68cd8b..8c0ad41 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
@@ -21,7 +21,7 @@ openapi: 3.0.3
 info:
   title: NCMP Inventory API
   description: NCMP Inventory API
-  version: "3.5.1"
+  version: "3.5.2"
 servers:
   - url: /ncmpInventory
 components:
@@ -40,4 +40,4 @@ paths:
     $ref: 'ncmp-inventory.yml#/searchCmHandleIds'
 
 security:
-  - basicAuth: []
\ No newline at end of file
+  - basicAuth: []

diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index bf23e4a..78fb141 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -22,7 +22,7 @@ openapi: 3.0.3
 info:
   title: NCMP to CPS Proxy API
   description: NCMP to CPS Proxy API
-  version: "3.5.1"
+  version: "3.5.2"
 servers:
   - url: /ncmp
 components:
@@ -64,4 +64,4 @@ paths:
   /v1/ch/{cm-handle}/data-sync:
     $ref: 'ncmp.yml#/setDataSyncEnabledFlag'
 security:
-  - basicAuth: []
\ No newline at end of file
+  - basicAuth: []

diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml
index 19494fc..70f06fb 100644 (file)
--- a/cps-rest/docs/openapi/openapi.yml
+++ b/cps-rest/docs/openapi/openapi.yml
@@ -23,7 +23,7 @@ openapi: 3.0.3
 info:
   title: ONAP Open API v3 Configuration Persistence Service
   description: Configuration Persistence Service is a Model Driven Generic Database
-  version: "3.5.1"
+  version: "3.5.2"
   contact:
      name: ONAP
      url: "https://onap.readthedocs.io"

diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 7cba581..d6cca6e 100644 (file)
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -9,11 +9,7 @@ info:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0
   title: ONAP Open API v3 Configuration Persistence Service
-  version: 1.0.0
-  x-planned-retirement-date: "202212"
-  x-component: Modeling
-  x-logo:
-    url: cps_logo.png
+  version: 3.5.2
 servers:
 - url: /cps/api
 security:
@@ -40,7 +36,7 @@ paths:
       responses:
         "201":
           content:
-            text/plain:
+            application/json:
               schema:
                 example: my-resource
                 type: string
@@ -364,7 +360,7 @@ paths:
       responses:
         "201":
           content:
-            text/plain:
+            application/json:
               schema:
                 example: my-resource
                 type: string
@@ -711,7 +707,7 @@ paths:
       responses:
         "201":
           content:
-            text/plain:
+            application/json:
               schema:
                 example: my-resource
                 type: string
@@ -1346,7 +1342,7 @@ paths:
         schema:
           example: 2021-03-21T00:10:34.030-0100
           type: string
-      - description: Content type header
+      - description: Content type in header
         in: header
         name: Content-Type
         required: true
@@ -1462,7 +1458,7 @@ paths:
         schema:
           example: 2021-03-21T00:10:34.030-0100
           type: string
-      - description: Content type header
+      - description: Content type in header
         in: header
         name: Content-Type
         required: true
@@ -1491,7 +1487,7 @@ paths:
       responses:
         "201":
           content:
-            text/plain:
+            application/json:
               schema:
                 example: my-resource
                 type: string
@@ -1587,6 +1583,13 @@ paths:
         schema:
           example: 2021-03-21T00:10:34.030-0100
           type: string
+      - description: Content type in header
+        in: header
+        name: Content-Type
+        required: true
+        schema:
+          example: application/json
+          type: string
       requestBody:
         content:
           application/json:
@@ -1594,8 +1597,17 @@ paths:
               dataSample:
                 $ref: '#/components/examples/dataSample'
                 value: null
+            schema:
+              type: string
+          application/xml:
+            examples:
+              dataSample:
+                $ref: '#/components/examples/dataSampleXml'
+                value: null
             schema:
               type: object
+              xml:
+                name: stores
         required: true
       responses:
         "200":
@@ -1762,6 +1774,13 @@ paths:
         schema:
           example: 2021-03-21T00:10:34.030-0100
           type: string
+      - description: Content type in header
+        in: header
+        name: Content-Type
+        required: true
+        schema:
+          example: application/json
+          type: string
       requestBody:
         content:
           application/json:
@@ -1769,13 +1788,22 @@ paths:
               dataSample:
                 $ref: '#/components/examples/dataSample'
                 value: null
+            schema:
+              type: string
+          application/xml:
+            examples:
+              dataSample:
+                $ref: '#/components/examples/dataSampleXml'
+                value: null
             schema:
               type: object
+              xml:
+                name: stores
         required: true
       responses:
         "201":
           content:
-            text/plain:
+            application/json:
               schema:
                 example: my-resource
                 type: string
@@ -1912,7 +1940,7 @@ paths:
       summary: Replace list content
       tags:
       - cps-data
-  /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaAnchors:
+  /v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta:
     get:
       description: Get delta between two anchors within a given dataspace
       operationId: getDeltaByDataspaceAndAnchors
@@ -1924,9 +1952,9 @@ paths:
         schema:
           example: my-dataspace
           type: string
-      - description: anchor-name
+      - description: source-anchor-name
         in: path
-        name: anchor-name
+        name: source-anchor-name
         required: true
         schema:
           example: my-anchor
@@ -2005,7 +2033,6 @@ paths:
       tags:
       - cps-data
       x-codegen-request-body-name: xpath
-  /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaPayload:
     post:
       description: Get delta between an anchor in a dataspace and JSON payload
       operationId: getDeltaByDataspaceAnchorAndPayload
@@ -2017,9 +2044,9 @@ paths:
         schema:
           example: my-dataspace
           type: string
-      - description: anchor-name
+      - description: source-anchor-name
         in: path
-        name: anchor-name
+        name: source-anchor-name
         required: true
         schema:
           example: my-anchor
@@ -2515,8 +2542,8 @@ components:
       schema:
         example: 2021-03-21T00:10:34.030-0100
         type: string
-    contentTypeHeader:
-      description: Content type header
+    contentTypeInHeader:
+      description: Content type in header
       in: header
       name: Content-Type
       required: true
@@ -2535,6 +2562,14 @@ components:
       required: true
       schema:
         type: string
+    sourceAnchorNameInPath:
+      description: source-anchor-name
+      in: path
+      name: source-anchor-name
+      required: true
+      schema:
+        example: my-anchor
+        type: string
     targetAnchorNameInQuery:
       description: target-anchor-name
       in: query
@@ -2577,7 +2612,7 @@ components:
   responses:
     Created:
       content:
-        text/plain:
+        application/json:
           schema:
             example: my-resource
             type: string

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 4f5180d..d710316 100644 (file)
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   description: NCMP Inventory API
   title: NCMP Inventory API
-  version: "1.0"
+  version: 3.5.2
 servers:
 - url: /ncmpInventory
 security:

diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 7b33fa1..a227add 100644 (file)
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   description: NCMP to CPS Proxy API
   title: NCMP to CPS Proxy API
-  version: "1.0"
+  version: 3.5.2
 servers:
 - url: /ncmp
 security:
@@ -608,7 +608,7 @@ paths:
     post:
       description: This request will be handled asynchronously using messaging to
         the supplied topic. The rest response will be an acknowledge with a requestId
-        to identify the relevant messages. A maximum of 50 cm handles per operation
+        to identify the relevant messages. A maximum of 200 cm handles per operation
         is supported.
       operationId: executeDataOperationForCmHandles
       parameters: