diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/openapi/components.yml | 11 | ||||
| -rw-r--r-- | docs/openapi/openapi.yml | 50 |
2 files changed, 61 insertions, 0 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml index c67dad69..05f1ac06 100644 --- a/docs/openapi/components.yml +++ b/docs/openapi/components.yml @@ -43,6 +43,17 @@ components: type: string example: system-001 + OperationalRequest: + type: object + properties: + operation: + type: string + enum: [ read ] + cmHandleProperties: + type: object + additionalProperties: + type: string + responses: NotFound: description: The specified resource was not found diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index f261c0da..a4a238c4 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -123,3 +123,53 @@ paths: $ref: 'components.yml#/components/responses/Unauthorized' '403': $ref: 'components.yml#/components/responses/Forbidden' + + /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational/{resourceIdentifier}: + put: + tags: + - dmi-plugin + summary: Get resource data for cm handle + description: Get resource data for given cm handle + operationId: getResourceDataOperationalForCmHandle + parameters: + - $ref: 'components.yml#/components/parameters/cmHandleInPath' + - name: resourceIdentifier + in: path + description: Resource identifier to fetch the resource data + required: true + schema: + type: string + - name: accept + in: header + 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 ] + - name: fields + in: query + description: Fields parameter to filter resource + required: false + schema: + type: string + - name: depth + in: query + description: Depth parameter for response + required: false + schema: + type: integer + minimum: 1 + requestBody: + description: Operational body + content: + application/json: + schema: + $ref: 'components.yml#/components/schemas/OperationalRequest' + responses: + '200': + $ref: 'components.yml#/components/responses/Ok' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' |