diff options
author | 2024-05-22 12:05:24 +0100 | |
---|---|---|
committer | 2024-05-22 15:16:56 +0000 | |
commit | 4fed286aa914f5a41f75a02dee6267fe77bbb025 (patch) | |
tree | be596d9c93fb2e762924851d95aeab1ab0ae8f63 | |
parent | 6d85c1547fad014fbea44af57440e3de1c3ce9ff (diff) |
Remove allowReserved from Swagger definitions for CPS & NCMP
- 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
-rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 4 | ||||
-rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 34 |
2 files changed, 10 insertions, 28 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 8aa38c0f7..a9311d086 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -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: diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index 9f6a1b2b6..7b33fa156 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -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: |