aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/components.yaml
diff options
context:
space:
mode:
authortragait <rahul.tyagi@est.tech>2021-08-16 15:12:36 +0100
committertragait <rahul.tyagi@est.tech>2021-08-19 12:46:37 +0100
commitc328551bdfd069343cc4c4e0249516d07938c78a (patch)
tree5beae0e58a123d67a4e89e904bc24d5239942437 /cps-ncmp-rest/docs/openapi/components.yaml
parent24112c0a500e94dc6068be71105874f8d81678b7 (diff)
get resource data for operational passthrough
Issue-ID: CPS-487 Signed-off-by: tragait <rahul.tyagi@est.tech> Change-Id: Id1b761f3f6a388556d0cc334fd6f196c78badc39
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/components.yaml')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml30
1 files changed, 30 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 9921041cf8..4f5a6a13e4 100644
--- 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: