diff options
| author |   tragait <rahul.tyagi@est.tech> | 2021-08-19 11:19:54 +0100 |
|---|---|---|
| committer | tragait <rahul.tyagi@est.tech> | 2021-08-19 11:19:59 +0100 |
| commit | f01d5674c738e1bc0e485a43f52e5cf19c9d81a7 (patch) | |
| tree | 3c3b942445b556db4d531c31b20f7aa92b725e9e /docs/openapi/openapi.yml | |
| parent | 577efb09a39282c608b53a3099b7edc95954f9c2 (diff) | |
Get resource data for pass-through running (dmi-impl)
Issue-ID: CPS-561
Signed-off-by: tragait <rahul.tyagi@est.tech>
Change-Id: Ia92a97296e2c3e84d0b6f6d9d1d0daf1e8f46b55
Diffstat (limited to 'docs/openapi/openapi.yml')
| -rw-r--r-- | docs/openapi/openapi.yml | 62 |
1 files changed, 35 insertions, 27 deletions
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index 114c521e..af285f4e 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -122,36 +122,44 @@ paths: put: tags: - dmi-plugin - summary: Get resource data for cm handle - description: Get resource data for given cm handle + summary: Get resource data from passthrough-operational for cm handle + description: Get resource data from passthrough-operational for 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 + - $ref: 'components.yml#/components/parameters/resourceIdentifierInPath' + - $ref: 'components.yml#/components/parameters/acceptParamInHeader' + - $ref: 'components.yml#/components/parameters/fieldsParamInQuery' + - $ref: 'components.yml#/components/parameters/depthParamInQuery' + 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' + + /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running/{resourceIdentifier}: + put: + tags: + - dmi-plugin + summary: Get resource data from passthrough-running for cm handle + description: Get resource data from passthrough-running for cm handle + operationId: getResourceDataPassthroughRunningForCmHandle + parameters: + - $ref: 'components.yml#/components/parameters/cmHandleInPath' + - $ref: 'components.yml#/components/parameters/resourceIdentifierInPath' + - $ref: 'components.yml#/components/parameters/acceptParamInHeader' + - $ref: 'components.yml#/components/parameters/fieldsParamInQuery' + - $ref: 'components.yml#/components/parameters/depthParamInQuery' requestBody: description: Operational body content: |