diff options
author | 2021-01-26 05:58:39 +0000 | |
---|---|---|
committer | 2021-01-26 14:48:17 +0000 | |
commit | 6d13f166f2e3d1c357677ad6f37f6e35238aeac6 (patch) | |
tree | 7236fc2960141e2e20f06700b32e83a64ae849c5 /cps-rest/docs/api/swagger/components.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/components.yml')
-rwxr-xr-x | cps-rest/docs/api/swagger/components.yml | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/cps-rest/docs/api/swagger/components.yml b/cps-rest/docs/api/swagger/components.yml new file mode 100755 index 000000000..9e306cda5 --- /dev/null +++ b/cps-rest/docs/api/swagger/components.yml @@ -0,0 +1,132 @@ +components: + schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + example: 400 + message: + type: string + example: Dataspace not found + details: + type: string + example: Dataspace with name D1 does not exist. + + MultipartFile: + required: + - file + properties: + multipartFile: + type: string + description: multipartFile + format: binary + example: http://example.com/examples/example.yang + + 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 + xpathInQuery: + name: cps-path + in: query + description: cps-path + required: false + schema: + type: string + default: / + includeDescendantsOptionInQuery: + name: include-descendants + in: query + description: include-descendants + required: false + schema: + type: boolean + default: false + + 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' + Conflict: + description: Conflict + 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: {} |