summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/ncmp.yml
diff options
context:
space:
mode:
authoremaclee <lee.anjella.macabuhay@est.tech>2021-12-01 09:42:37 +0000
committeremaclee <lee.anjella.macabuhay@est.tech>2021-12-03 14:06:34 +0000
commit844cab3ac9487375b833437e6f078f5771c0e5b4 (patch)
treefea20cb33ffa9e0686a51edc79cbf4c7f1616a9e /cps-ncmp-rest/docs/openapi/ncmp.yml
parent1a07fc039140525af388d6b8c30fbbce9e1ebf9f (diff)
CPS-723: Add Examples in the NCMP openapi
Issue-ID: CPS-723 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I1263402595c0f97db7390716fcf8e086edc0a78a
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmp.yml')
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp.yml36
1 files changed, 31 insertions, 5 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index 611e84e01e..e89bfdb90f 100755
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -194,7 +194,14 @@ getResourceDataForPassthroughOperational:
- $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
responses:
200:
- $ref: 'components.yaml#/components/responses/Ok'
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ examples:
+ dataSampleResponse:
+ $ref: 'components.yaml#/components/examples/dataSampleResponse'
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401:
@@ -218,7 +225,14 @@ resourceDataForPassthroughRunning:
- $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
responses:
200:
- $ref: 'components.yaml#/components/responses/Ok'
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ examples:
+ dataSampleResponse:
+ $ref: 'components.yaml#/components/examples/dataSampleResponse'
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401:
@@ -243,6 +257,9 @@ resourceDataForPassthroughRunning:
application/json:
schema:
type: string
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
application/yang-data+json:
schema:
type: string
@@ -274,6 +291,9 @@ resourceDataForPassthroughRunning:
application/json:
schema:
type: string
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
application/yang-data+json:
schema:
type: string
@@ -304,9 +324,15 @@ fetchModuleReferencesByCmHandle:
content:
application/json:
schema:
- type: string
- example: [{"moduleName": "nc-notifications", "revision": "2008-07-14"}]
- $ref: 'components.yaml#/components/responses/Ok'
+ type: object
+ examples:
+ moduleReferencesResponse:
+ summary: Sample response
+ value:
+ - moduleName: my-module-name
+ revision: yyyy-mm-dd
+ - moduleName: my-module-name-2
+ revision: yyyy-mm-dd
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401: