Remove allowReserved from Swagger definitions for CPS & NCMP 39/138039/2
authorToineSiebelink <toine.siebelink@est.tech>
Wed, 22 May 2024 11:05:24 +0000 (12:05 +0100)
committerToine Siebelink <toine.siebelink@est.tech>
Wed, 22 May 2024 15:16:56 +0000 (15:16 +0000)
- this option was used on some URL parameters (by accident)
- does not seem to affect production code but is at least misleading

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

cps-ncmp-rest/docs/openapi/components.yaml
docs/api/swagger/ncmp/openapi.yaml

index 8aa38c0..a9311d0 100644 (file)
@@ -578,7 +578,6 @@ components:
       in: query
       description: The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything.
       required: true
-      allowReserved: true
       schema:
         type: string
       examples:
@@ -598,7 +597,6 @@ components:
       required: false
       schema:
         type: string
-      allowReserved: true
       examples:
         sample 1:
           value:
@@ -616,7 +614,6 @@ components:
       required: false
       schema:
         type: string
-      allowReserved: true
       examples:
         sample 1:
           value:
@@ -628,7 +625,6 @@ components:
       required: true
       schema:
         type: string
-      allowReserved: true
       examples:
         sample 1:
           value:
index 9f6a1b2..7b33fa1 100644 (file)
@@ -28,8 +28,7 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - allowReserved: true
-        description: The format of resource identifier depend on the associated DMI
+      - description: The format of resource identifier depend on the associated DMI
           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
           it can really be anything.
         examples:
@@ -139,8 +138,7 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - allowReserved: true
-        description: The format of resource identifier depend on the associated DMI
+      - description: The format of resource identifier depend on the associated DMI
           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
           it can really be anything.
         examples:
@@ -158,8 +156,7 @@ paths:
         required: true
         schema:
           type: string
-      - allowReserved: true
-        description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
           \ in parenthesis'()'. The format of options parameter depend on the associated\
           \ DMI Plugin implementation."
         examples:
@@ -177,8 +174,7 @@ paths:
         required: false
         schema:
           type: string
-      - allowReserved: true
-        description: topic parameter in query.
+      - description: topic parameter in query.
         examples:
           sample 1:
             value:
@@ -276,8 +272,7 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - allowReserved: true
-        description: The format of resource identifier depend on the associated DMI
+      - description: The format of resource identifier depend on the associated DMI
           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
           it can really be anything.
         examples:
@@ -390,8 +385,7 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - allowReserved: true
-        description: The format of resource identifier depend on the associated DMI
+      - description: The format of resource identifier depend on the associated DMI
           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
           it can really be anything.
         examples:
@@ -509,8 +503,7 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - allowReserved: true
-        description: The format of resource identifier depend on the associated DMI
+      - description: The format of resource identifier depend on the associated DMI
           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
           it can really be anything.
         examples:
@@ -619,8 +612,7 @@ paths:
         is supported.
       operationId: executeDataOperationForCmHandles
       parameters:
-      - allowReserved: true
-        description: mandatory topic parameter in query.
+      - description: mandatory topic parameter in query.
         examples:
           sample 1:
             value:
@@ -736,8 +728,7 @@ paths:
         schema:
           default: /
           type: string
-      - allowReserved: true
-        description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
           \ in parenthesis'()'. The format of options parameter depend on the associated\
           \ DMI Plugin implementation."
         examples:
@@ -755,8 +746,7 @@ paths:
         required: false
         schema:
           type: string
-      - allowReserved: true
-        description: topic parameter in query.
+      - description: topic parameter in query.
         examples:
           sample 1:
             value:
@@ -1484,7 +1474,6 @@ components:
         example: my-cm-handle
         type: string
     resourceIdentifierInQuery:
-      allowReserved: true
       description: The format of resource identifier depend on the associated DMI
         Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
         can really be anything.
@@ -1504,7 +1493,6 @@ components:
       schema:
         type: string
     optionsParamInQuery:
-      allowReserved: true
       description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
         \ in parenthesis'()'. The format of options parameter depend on the associated\
         \ DMI Plugin implementation."
@@ -1524,7 +1512,6 @@ components:
       schema:
         type: string
     topicParamInQuery:
-      allowReserved: true
       description: topic parameter in query.
       examples:
         sample 1:
@@ -1561,7 +1548,6 @@ components:
         example: application/yang-data+json
         type: string
     requiredTopicParamInQuery:
-      allowReserved: true
       description: mandatory topic parameter in query.
       examples:
         sample 1: