diff options
| author |   puthuparambil.aditya <aditya.puthuparambil@bell.ca> | 2021-01-13 12:06:20 +0000 |
|---|---|---|
| committer |   Rishi Chail <rishi.chail@est.tech> | 2021-01-15 06:52:13 +0000 |
| commit | 001e7738f4968ec390ea8af36de019aa87e3c2f2 (patch) | |
| tree | 13347974f001bdf596dca49a0c64924aa70e1703 /cps-rest/docs/api/swagger/cpsAdmin.yml | |
| parent | d45b2dc0ec3bb7d56ef1eee784a887459f609832 (diff) | |
Split OpenAPI yaml file
1. components like schema, parameters, responses, requestBodies all moved to components.yml (https://swagger.io/docs/specification/components/)
2. CpAdmin.yml includes the configuration details for cpsAdmin APIs
3. CpsData.yml includes the API configuration details for cpsData
Issue-ID: CPS-155
Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
Change-Id: I18fb9b8a2be85d180d4625657aca399dbf60b7bc
Diffstat (limited to 'cps-rest/docs/api/swagger/cpsAdmin.yml')
| -rw-r--r-- | cps-rest/docs/api/swagger/cpsAdmin.yml | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/cps-rest/docs/api/swagger/cpsAdmin.yml b/cps-rest/docs/api/swagger/cpsAdmin.yml new file mode 100644 index 0000000000..948c43b763 --- /dev/null +++ b/cps-rest/docs/api/swagger/cpsAdmin.yml @@ -0,0 +1,165 @@ +dataspace: + post: + tags: + - cps-admin + summary: Create a new dataspace + operationId: createDataspace + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInQuery' + 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' + +dataspaceByDataspaceName: + delete: + tags: + - cps-admin + summary: Delete the given dataspace - DRAFT + operationId: deleteDataspace + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + responses: + 200: + $ref: 'components.yaml#/components/responses/Ok' + 204: + $ref: 'components.yaml#/components/responses/NoContent' + 400: + $ref: 'components.yaml#/components/responses/BadRequest' + 401: + $ref: 'components.yaml#/components/responses/Unauthorized' + 403: + $ref: 'components.yaml#/components/responses/Forbidden' + + +schemaSet: + post: + tags: + - cps-admin + summary: Create a new schema set in the given dataspace + operationId: createSchemaSet + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yaml#/components/parameters/schemaSetNameInQuery' + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: 'components.yaml#/components/schemas/MultipartFile' + + 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' + +schemaSetBySchemaSetName: + get: + tags: + - cps-admin + summary: Read a schema set given a schema set and a dataspace + operationId: getSchemaSet + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yaml#/components/parameters/schemaSetNameInPath' + 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' + +anchorsByDataspace: + get: + tags: + - cps-admin + summary: Read all anchors, given a dataspace + operationId: getAnchors + parameters: + - $ref: 'components.yaml#/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' + + post: + tags: + - cps-admin + summary: Create a new anchor in the given dataspace + operationId: createAnchor + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yaml#/components/parameters/schemaSetNameInQuery' + - $ref: 'components.yaml#/components/parameters/anchorNameInQuery' + 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' + +anchorByDataspaceAndAnchorName: + get: + tags: + - cps-admin + summary: Read an anchor given a anchor and a dataspace - DRAFT + operationId: getAnchor + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yaml#/components/parameters/anchorNameInPath' + 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' + + delete: + tags: + - cps-admin + summary: Delete an anchor given a anchor and a dataspace - DRAFT + operationId: deleteAnchor + parameters: + - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yaml#/components/parameters/anchorNameInPath' + responses: + 200: + $ref: 'components.yaml#/components/responses/Ok' + 204: + $ref: 'components.yaml#/components/responses/NoContent' + 400: + $ref: 'components.yaml#/components/responses/BadRequest' + 401: + $ref: 'components.yaml#/components/responses/Unauthorized' + 403: + $ref: 'components.yaml#/components/responses/Forbidden'
\ No newline at end of file |