get resource data for operational passthrough

[cps.git] / cps-ncmp-rest / docs / openapi / components.yaml

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 9921041..4f5a6a1 100644 (file)
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -96,6 +96,36 @@ components:
       schema:
         type: string
         default: /
+    resourceIdentifierInPath:
+      name: resourceIdentifier
+      in: path
+      description: Resource identifier to get/set the resource data
+      required: true
+      schema:
+        type: string
+    acceptParamInHeader:
+      name: accept
+      in: header
+      required: false
+      description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
+      schema:
+        type: string
+        enum: [ application/json, application/yang-data+json ]
+    fieldsParamInQuery:
+      name: fields
+      in: query
+      description: Fields parameter to filter resource
+      required: false
+      schema:
+        type: string
+    depthParamInQuery:
+      name: depth
+      in: query
+      description: Depth parameter for response
+      required: false
+      schema:
+        type: integer
+        minimum: 1
 
 
   responses: