summaryrefslogtreecommitdiffstats
path: root/docs/openapi/components.yml
diff options
context:
space:
mode:
authortragait <rahul.tyagi@est.tech>2021-10-04 16:02:57 +0100
committertragait <rahul.tyagi@est.tech>2021-10-06 15:21:12 +0100
commit907e3785a7cbaba28f5d4bf7ce3c4a7b47dff39e (patch)
treef726e5dcdd5e485dc3e840cb850504bc7c5df78e /docs/openapi/components.yml
parent9ee0feb24f8f75ce05cf9e34e4621cf2b226657e (diff)
fix query param to options
Issue-ID: CPS-678 Signed-off-by: tragait <rahul.tyagi@est.tech> Change-Id: I4ac72da512e2c7883920907137b8834ce20d4528
Diffstat (limited to 'docs/openapi/components.yml')
-rw-r--r--docs/openapi/components.yml45
1 files changed, 23 insertions, 22 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index 736639d8..a03cb1f8 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -40,10 +40,7 @@ components:
revision:
type: string
cmHandleProperties:
- type: object
- additionalProperties:
- type: string
- example: system-001
+ $ref: '#/components/schemas/cmHandleProperties'
ModuleSet:
type: object
@@ -82,9 +79,7 @@ components:
type: string
enum: [ read ]
cmHandleProperties:
- type: object
- additionalProperties:
- type: string
+ $ref: '#/components/schemas/cmHandleProperties'
DataAccessWriteRequest:
type: object
@@ -97,9 +92,13 @@ components:
data:
type: string
cmHandleProperties:
- type: object
- additionalProperties:
- type: string
+ $ref: '#/components/schemas/cmHandleProperties'
+
+ cmHandleProperties:
+ type: object
+ additionalProperties:
+ type: string
+ example: {"prop1":"value1","prop2":"value2"}
responses:
NotFound:
@@ -174,19 +173,21 @@ components:
type: string
enum: [ application/json, application/yang-data+json ]
- fieldsParamInQuery:
- name: fields
+ optionsParamInQuery:
+ name: options
in: query
- description: Fields parameter to filter resource
+ description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
required: false
schema:
type: string
-
- depthParamInQuery:
- name: depth
- in: query
- description: Depth parameter for response
- required: false
- schema:
- type: integer
- minimum: 1 \ No newline at end of file
+ allowReserved: true
+ 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]) \ No newline at end of file