diff options
Diffstat (limited to 'cps-ncmp-rest/docs/openapi')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 30 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmproxy.yml | 27 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/openapi.yml | 7 |
3 files changed, 62 insertions, 2 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 9921041cf..4f5a6a13e 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: diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml index 3ec7bfd11..ede0ec62f 100755 --- a/cps-ncmp-rest/docs/openapi/ncmproxy.yml +++ b/cps-ncmp-rest/docs/openapi/ncmproxy.yml @@ -200,4 +200,29 @@ updateDmiRegistration: 401: $ref: 'components.yaml#/components/responses/Unauthorized' 403: - $ref: 'components.yaml#/components/responses/Forbidden'
\ No newline at end of file + $ref: 'components.yaml#/components/responses/Forbidden' + +getResourceDataForPassthroughOperational: + get: + tags: + - network-cm-proxy + summary: Get resource data from pass-through operational for cm handle + description: Get resource data from pass-through operational for given cm handle + operationId: getResourceDataOperationalForCmHandle + parameters: + - $ref: 'components.yaml#/components/parameters/cmHandleInPath' + - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath' + - $ref: 'components.yaml#/components/parameters/acceptParamInHeader' + - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery' + - $ref: 'components.yaml#/components/parameters/depthParamInQuery' + responses: + 200: + $ref: 'components.yaml#/components/responses/Ok' + 400: + $ref: 'components.yaml#/components/responses/BadRequest' + 401: + $ref: 'components.yaml#/components/responses/Unauthorized' + 403: + $ref: 'components.yaml#/components/responses/Forbidden' + 404: + $ref: 'components.yaml#/components/responses/NotFound'
\ No newline at end of file diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml index 64de9223f..5b7c8d205 100755 --- a/cps-ncmp-rest/docs/openapi/openapi.yml +++ b/cps-ncmp-rest/docs/openapi/openapi.yml @@ -38,4 +38,9 @@ paths: $ref: 'ncmproxy.yml#/nodesByCmHandleAndXpath' /ncmp-dmi/v1/ch: - $ref: 'ncmproxy.yml#/updateDmiRegistration'
\ No newline at end of file + $ref: 'ncmproxy.yml#/updateDmiRegistration' + + /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational/{resourceIdentifier}: + $ref: 'ncmproxy.yml#/getResourceDataForPassthroughOperational' + +
\ No newline at end of file |