summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/api/swagger/components.yml
diff options
context:
space:
mode:
authorJosephKeenan <joseph.keenan@est.tech>2021-05-24 17:42:23 +0100
committerJosephKeenan <joseph.keenan@est.tech>2021-05-26 16:46:29 +0100
commiteef2e112d1f447b47f2f19d24e9dfd9a76550333 (patch)
tree60db7b08fa88f297433f4f13eaecee7fd4d46d97 /cps-rest/docs/api/swagger/components.yml
parent576f48e8d3ef2ac7526b5684eba0a3e8259ce3cc (diff)
Aligning differing openAPI paths (cps-rest & ncmp-rest)
Issue-ID: CPS-427 Change-Id: I1d6853419923994feed4d9c38482818f17202e36 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
Diffstat (limited to 'cps-rest/docs/api/swagger/components.yml')
-rwxr-xr-xcps-rest/docs/api/swagger/components.yml147
1 files changed, 0 insertions, 147 deletions
diff --git a/cps-rest/docs/api/swagger/components.yml b/cps-rest/docs/api/swagger/components.yml
deleted file mode 100755
index 5a21a730e..000000000
--- a/cps-rest/docs/api/swagger/components.yml
+++ /dev/null
@@ -1,147 +0,0 @@
-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: xpath
- in: query
- description: xpath
- required: false
- schema:
- type: string
- default: /
- requiredXpathInQuery:
- name: xpath
- in: query
- description: xpath
- required: true
- schema:
- type: string
- cpsPathInQuery:
- 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: {}