Remove allowReserved from Swagger definitions

- this option was used on some URL parameters (by accident)
- does not seem to affect production code but is at least misleadingt)

Issue-ID: CPS-2230
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Change-Id: I714d49fa8f8ac0ef9f1e654aad94b8a7fc2e7792

diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml
index 0f690ef..ceb6191 100644 (file)
--- a/docs/api/swagger/openapi.yaml
+++ b/docs/api/swagger/openapi.yaml
@@ -4,26 +4,26 @@ info:
   title: NCMP DMI Plugin
   version: 1.0.0
 servers:
-  - url: /dmi
+- url: /dmi
 tags:
-  - description: DMI plugin internal rest apis
-    name: dmi-plugin-internal
-  - description: DMI plugin rest apis
-    name: dmi-plugin
+- description: DMI plugin internal rest apis
+  name: dmi-plugin-internal
+- description: DMI plugin rest apis
+  name: dmi-plugin
 paths:
   /v1/ch/{cmHandle}/modules:
     post:
       description: Get all modules for given cm handle
       operationId: getModuleReferences
       parameters:
-        - description: "The identifier for a network function, network element, subnetwork,\
+      - description: "The identifier for a network function, network element, subnetwork,\
           \ or any other cm object by managed Network CM Proxy"
-          in: path
-          name: cmHandle
-          required: true
-          schema:
-            example: my-cm-handle
-            type: string
+        in: path
+        name: cmHandle
+        required: true
+        schema:
+          example: my-cm-handle
+          type: string
       requestBody:
         content:
           application/json:
@@ -59,20 +59,20 @@ paths:
           description: Internal Server Error
       summary: Get all modules for cm handle
       tags:
-        - dmi-plugin
+      - dmi-plugin
   /v1/ch/{cmHandle}/moduleResources:
     post:
       description: Retrieve module resources for one or more modules
       operationId: retrieveModuleResources
       parameters:
-        - description: "The identifier for a network function, network element, subnetwork,\
+      - description: "The identifier for a network function, network element, subnetwork,\
           \ or any other cm object by managed Network CM Proxy"
-          in: path
-          name: cmHandle
-          required: true
-          schema:
-            example: my-cm-handle
-            type: string
+        in: path
+        name: cmHandle
+        required: true
+        schema:
+          example: my-cm-handle
+          type: string
       requestBody:
         content:
           application/json:
@@ -108,7 +108,7 @@ paths:
           description: Internal Server Error
       summary: Retrieve module resources
       tags:
-        - dmi-plugin
+      - dmi-plugin
   /v1/inventory/cmHandles:
     post:
       description: register given list of cm handles (internal use only)
@@ -150,7 +150,7 @@ paths:
           description: Internal Server Error
       summary: register given list of cm handles (internal use only)
       tags:
-        - dmi-plugin-internal
+      - dmi-plugin-internal
       x-api-audience: component-internal
   /v1/ch/{cmHandle}/data/ds/{datastore-name}:
     post:
@@ -158,66 +158,63 @@ paths:
         cm handle
       operationId: dataAccessPassthrough
       parameters:
-        - description: The type of the requested data
-          in: path
-          name: datastore-name
-          required: true
-          schema:
-            example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
-            type: string
-        - description: "The identifier for a network function, network element, subnetwork,\
+      - description: The type of the requested data
+        in: path
+        name: datastore-name
+        required: true
+        schema:
+          example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
+          type: string
+      - description: "The identifier for a network function, network element, subnetwork,\
           \ or any other cm object by managed Network CM Proxy"
-          in: path
-          name: cmHandle
-          required: true
-          schema:
-            example: my-cm-handle
-            type: string
-        - allowReserved: true
-          description: Resource identifier to get/set the resource data
-          in: query
-          name: resourceIdentifier
-          required: true
-          schema:
-            example: my-schema:my-node
-            type: string
-        - allowReserved: true
-          description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+        in: path
+        name: cmHandle
+        required: true
+        schema:
+          example: my-cm-handle
+          type: string
+      - description: Resource identifier to get/set the resource data
+        in: query
+        name: resourceIdentifier
+        required: true
+        schema:
+          example: my-schema:my-node
+          type: string
+      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
           \ in parenthesis'()'."
-          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)"
-          in: query
-          name: options
-          required: false
-          schema:
-            type: string
-        - allowReserved: true
-          description: topic name passed from client(NCMP).
-          examples:
-            sample1:
-              value: my-topic-name
-          in: query
-          name: topic
-          required: false
-          schema:
-            type: string
-        - name: moduleSetTag
-          description: Module set tag of the given cm handle.
-          in: query
-          examples:
-            sample1:
-              value: module-set-tag1
-          required: false
-          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)"
+        in: query
+        name: options
+        required: false
+        schema:
+          type: string
+      - description: topic name passed from client(NCMP).
+        examples:
+          sample1:
+            value: my-topic-name
+        in: query
+        name: topic
+        required: false
+        schema:
+          type: string
+      - description: Module set tag of the given cm handle.
+        examples:
+          sample1:
+            value: tag1
+        in: query
+        name: moduleSetTag
+        required: false
+        schema:
+          type: string
       requestBody:
         content:
           application/json:
@@ -231,9 +228,9 @@ paths:
             application/json:
               schema:
                 example:
-                  - yangSource: my-yang-source
-                    moduleName: my-module-name
-                    revision: my-revision
+                - yangSource: my-yang-source
+                  moduleName: my-module-name
+                  revision: my-revision
                 type: object
           description: OK
         "400":
@@ -259,35 +256,33 @@ paths:
       summary: Get resource data from passthrough operational or running for a cm
         handle
       tags:
-        - dmi-plugin
+      - dmi-plugin
   /v1/data:
     post:
       description: Execute a data operation for group of cm handle ids by supplied
         operation details
       operationId: getResourceDataForCmHandleDataOperation
       parameters:
-        - allowReserved: true
-          description: mandatory topic name passed from client(NCMP).
-          examples:
-            sample1:
-              value:
-                topic: my-topic-name
-          in: query
-          name: topic
-          required: true
-          schema:
-            type: string
-        - allowReserved: true
-          description: request Id generated by NCMP and sent as an acknowledgement for
-            the client request the same including here.
-          examples:
-            sample1:
-              value: 4753fc1f-7de2-449a-b306-a6204b5370b3
-          in: query
-          name: requestId
-          required: true
-          schema:
-            type: string
+      - description: mandatory topic name passed from client(NCMP).
+        examples:
+          sample1:
+            value:
+              topic: my-topic-name
+        in: query
+        name: topic
+        required: true
+        schema:
+          type: string
+      - description: request Id generated by NCMP and sent as an acknowledgement for
+          the client request the same including here.
+        examples:
+          sample1:
+            value: 4753fc1f-7de2-449a-b306-a6204b5370b3
+        in: query
+        name: requestId
+        required: true
+        schema:
+          type: string
       requestBody:
         content:
           application/json:
@@ -329,7 +324,7 @@ paths:
           description: Not Implemented
       summary: Execute a data operation for group of cm handle ids.
       tags:
-        - dmi-plugin
+      - dmi-plugin
 components:
   parameters:
     cmHandleInPath:
@@ -350,7 +345,6 @@ components:
         example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
         type: string
     resourceIdentifierInQuery:
-      allowReserved: true
       description: Resource identifier to get/set the resource data
       in: query
       name: resourceIdentifier
@@ -359,7 +353,6 @@ components:
         example: my-schema:my-node
         type: string
     optionsParamInQuery:
-      allowReserved: true
       description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
         \ in parenthesis'()'."
       examples:
@@ -378,7 +371,6 @@ components:
       schema:
         type: string
     topicParamInQuery:
-      allowReserved: true
       description: topic name passed from client(NCMP).
       examples:
         sample1:
@@ -389,17 +381,16 @@ components:
       schema:
         type: string
     moduleSetTagParamInQuery:
-      name: moduleSetTag
-      in: query
       description: Module set tag of the given cm handle.
+      examples:
+        sample1:
+          value: tag1
+      in: query
+      name: moduleSetTag
       required: false
       schema:
         type: string
-      examples:
-        sample1:
-          value: module-set-tag1
     requiredTopicParamInQuery:
-      allowReserved: true
       description: mandatory topic name passed from client(NCMP).
       examples:
         sample1:
@@ -411,7 +402,6 @@ components:
       schema:
         type: string
     requiredRequestIdParamInQuery:
-      allowReserved: true
       description: request Id generated by NCMP and sent as an acknowledgement for
         the client request the same including here.
       examples:
@@ -488,12 +478,12 @@ components:
     ModuleSet:
       example:
         schemas:
-          - moduleName: my-module-name
-            namespace: my-namespace
-            revision: my-revision
-          - moduleName: my-module-name
-            namespace: my-namespace
-            revision: my-revision
+        - moduleName: my-module-name
+          namespace: my-namespace
+          revision: my-revision
+        - moduleName: my-module-name
+          namespace: my-namespace
+          revision: my-revision
       properties:
         schemas:
           items:
@@ -512,16 +502,20 @@ components:
       type: object
     ModuleResourcesReadRequest:
       example:
-        moduleSetTag: module-set-tag1
         data:
           modules:
-            - name: my-name
-              revision: my-revision
-            - name: my-name
-              revision: my-revision
+          - name: my-name
+            revision: my-revision
+          - name: my-name
+            revision: my-revision
+        moduleSetTag: Module-set-tag-1
         cmHandleProperties:
           key: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
       properties:
+        moduleSetTag:
+          description: Module set tag of the given cm handle
+          example: Module-set-tag-1
+          type: string
         data:
           $ref: '#/components/schemas/ModuleResourcesReadRequest_data'
         cmHandleProperties:
@@ -553,15 +547,15 @@ components:
     CmHandles:
       example:
         cmHandles:
-          - cmHandleId1
-          - cmHandleId2
-          - cmHandleId3
+        - cmHandleId1
+        - cmHandleId2
+        - cmHandleId3
       properties:
         cmHandles:
           example:
-            - cmHandleId1
-            - cmHandleId2
-            - cmHandleId3
+          - cmHandleId1
+          - cmHandleId2
+          - cmHandleId3
           items:
             type: string
           type: array
@@ -577,11 +571,11 @@ components:
       properties:
         operation:
           enum:
-            - read
-            - create
-            - update
-            - patch
-            - delete
+          - read
+          - create
+          - update
+          - patch
+          - delete
           example: read
           type: string
         dataType:
@@ -604,12 +598,13 @@ components:
       items:
         $ref: '#/components/schemas/DataOperationRequest'
       type: array
-    cmHandle:
+    dmiOperationCmHandle:
       example:
         id: cmHandle123
         cmHandleProperties:
           myProp: some value
           otherProp: other value
+          moduleSetTag: module-set-tag1
       properties:
         id:
           type: string
@@ -617,7 +612,10 @@ components:
           additionalProperties:
             type: string
           type: object
-      title: cmHandle
+        moduleSetTag:
+          example: module-set-tag1
+          type: string
+      title: CmHandle with properties for DMI
       type: object
     ModuleSet_schemas_inner:
       example:
@@ -650,10 +648,10 @@ components:
     ModuleResourcesReadRequest_data:
       example:
         modules:
-          - name: my-name
-            revision: my-revision
-          - name: my-name
-            revision: my-revision
+        - name: my-name
+          revision: my-revision
+        - name: my-name
+          revision: my-revision
       properties:
         modules:
           items:
@@ -667,16 +665,16 @@ components:
         options: some option
         operationId: "12"
         cmHandles:
-          - id: cmHandle123
-            cmHandleProperties:
-              myProp: some value
-              otherProp: other value
-              moduleSetTag: module-set-tag1
-          - id: cmHandle123
-            cmHandleProperties:
-              myProp: some value
-              otherProp: other value
-              moduleSetTag: module-set-tag2
+        - id: cmHandle123
+          cmHandleProperties:
+            myProp: some value
+            otherProp: other value
+            moduleSetTag: module-set-tag1
+        - id: cmHandle123
+          cmHandleProperties:
+            myProp: some value
+            otherProp: other value
+            moduleSetTag: module-set-tag1
         operation: read
       properties:
         operation:
@@ -698,12 +696,12 @@ components:
           type: string
         cmHandles:
           items:
-            $ref: '#/components/schemas/cmHandle'
+            $ref: '#/components/schemas/dmiOperationCmHandle'
           type: array
       required:
-        - cmHandles
-        - datastore
-        - operation
-        - operationId
+      - cmHandles
+      - datastore
+      - operation
+      - operationId
       title: DataOperationRequest
       type: object

diff --git a/openapi/components.yml b/openapi/components.yml
index ae9710b..3142654 100644 (file)
--- a/openapi/components.yml
+++ b/openapi/components.yml
@@ -252,7 +252,6 @@ components:
       in: query
       description: Resource identifier to get/set the resource data
       required: true
-      allowReserved: true
       schema:
         type: string
         example: my-schema:my-node
@@ -264,7 +263,6 @@ components:
       required: false
       schema:
         type: string
-      allowReserved: true
       examples:
         sample1:
           value:
@@ -283,7 +281,6 @@ components:
       required: false
       schema:
         type: string
-      allowReserved: true
       examples:
         sample1:
           value: my-topic-name
@@ -295,7 +292,6 @@ components:
       required: true
       schema:
         type: string
-      allowReserved: true
       examples:
         sample1:
           value:
@@ -319,7 +315,6 @@ components:
       required: true
       schema:
         type: string
-      allowReserved: true
       examples:
         sample1:
           value: 4753fc1f-7de2-449a-b306-a6204b5370b3
@@ -334,4 +329,4 @@ components:
         example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
 
 security:
-  - basicAuth: []
\ No newline at end of file
+  - basicAuth: []