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/components.yaml | |
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/components.yaml')
-rw-r--r-- | cps-rest/docs/api/swagger/components.yaml | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/cps-rest/docs/api/swagger/components.yaml b/cps-rest/docs/api/swagger/components.yaml new file mode 100644 index 0000000000..ab964a93a0 --- /dev/null +++ b/cps-rest/docs/api/swagger/components.yaml @@ -0,0 +1,105 @@ +components: + schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + message: + type: string + details: + type: string + MultipartFile: + required: + - file + properties: + multipartFile: + type: string + description: multipartFile + format: binary + + parameters: + dataspaceNameInQuery: + name: dataspace-name + in: query + description: dataspace-name + required: true + schema: + type: string + dataspaceNameInPath: + name: dataspace-name + in: path + description: dataspace-name + required: true + schema: + type: string + anchorNameInPath: + name: anchor-name + in: path + description: anchor-name + required: true + schema: + type: string + schemaSetNameInQuery: + name: schema-set-name + in: query + description: schema-set-name + required: true + schema: + type: string + schemaSetNameInPath: + name: schema-set-name + in: path + description: schema-set-name + required: true + schema: + type: string + anchorNameInQuery: + name: anchor-name + in: query + description: anchor-name + required: true + schema: + type: string + + responses: + NotFound: + description: The specified resource was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Unauthorized: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + BadRequest: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Ok: + description: OK + content: + application/json: + schema: + type: object + Created: + description: Created + content: + text/plain: + schema: + type: string + NoContent: + description: No Content + content: {} |