diff options
| author |   Rishi.Chail <rishi.chail@est.tech> | 2021-01-26 05:58:39 +0000 |
|---|---|---|
| committer | Rishi.Chail <rishi.chail@est.tech> | 2021-01-26 14:48:17 +0000 |
| commit | 6d13f166f2e3d1c357677ad6f37f6e35238aeac6 (patch) | |
| tree | 7236fc2960141e2e20f06700b32e83a64ae849c5 /cps-rest/docs/api/swagger/cpsData.yml | |
| parent | c7b1283b6a13a03cc36af57f6ec550a0b2adcb3c (diff) | |
Ensure CPS REST API Specs conform to ONAP standards
Issue-ID: CPS-25
Signed-off-by: Rishi.Chail <rishi.chail@est.tech>
Change-Id: I17fec852cf2dcb824dfc0ab7f00ebe4cfd9e09b5
Diffstat (limited to 'cps-rest/docs/api/swagger/cpsData.yml')
| -rwxr-xr-x[-rw-r--r--] | cps-rest/docs/api/swagger/cpsData.yml | 83 |
1 files changed, 43 insertions, 40 deletions
diff --git a/cps-rest/docs/api/swagger/cpsData.yml b/cps-rest/docs/api/swagger/cpsData.yml index 97bf21a3e8..9abace2047 100644..100755 --- a/cps-rest/docs/api/swagger/cpsData.yml +++ b/cps-rest/docs/api/swagger/cpsData.yml @@ -1,35 +1,37 @@ nodesByDataspaceAndAnchor: get: + description: Get a node with an option to retrieve all the children for a given anchor and dataspace tags: - cps-data - summary: Get a node given an anchor for the given dataspace + summary: Get a node operationId: getNodeByDataspaceAndAnchor parameters: - - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' - - $ref: 'components.yaml#/components/parameters/anchorNameInPath' - - $ref: 'components.yaml#/components/parameters/xpathInQuery' - - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery' + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/anchorNameInPath' + - $ref: 'components.yml#/components/parameters/xpathInQuery' + - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery' 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' + '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' + '404': + $ref: 'components.yml#/components/responses/NotFound' x-codegen-request-body-name: xpath post: + description: Create a node for a given anchor and dataspace tags: - cps-data - summary: Create a node for a given anchor for the given dataspace + summary: Create a node operationId: createNode parameters: - - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' - - $ref: 'components.yaml#/components/parameters/anchorNameInPath' + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/anchorNameInPath' requestBody: required: true content: @@ -37,32 +39,33 @@ nodesByDataspaceAndAnchor: schema: type: string responses: - 201: - $ref: 'components.yaml#/components/responses/Created' - 400: - $ref: 'components.yaml#/components/responses/BadRequest' - 401: - $ref: 'components.yaml#/components/responses/Unauthorized' - 403: - $ref: 'components.yaml#/components/responses/Forbidden' + '201': + $ref: 'components.yml#/components/responses/Created' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' nodesByDataspace: get: + description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT tags: - cps-data - summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT - operationId: getNodeByDataspace + summary: Get nodes + operationId: getNodesByDataspace parameters: - - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' 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' - x-codegen-request-body-name: requestBody
\ No newline at end of file + '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' + '404': + $ref: 'components.yml#/components/responses/NotFound' + x-codegen-request-body-name: requestBody |