Merge "Decouple configuration from application"
[cps.git] / cps-rest / docs / api / swagger / cpsData.yml
1 nodesByDataspaceAndAnchor:
2   get:
3     tags:
4       - cps-data
5     summary: Get a node given an anchor for the given dataspace - DRAFT
6     operationId: getNodeByDataspaceAndAnchor
7     parameters:
8       - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
9       - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
10     responses:
11       200:
12         $ref: 'components.yaml#/components/responses/Ok'
13       400:
14         $ref: 'components.yaml#/components/responses/BadRequest'
15       401:
16         $ref: 'components.yaml#/components/responses/Unauthorized'
17       403:
18         $ref: 'components.yaml#/components/responses/Forbidden'
19       404:
20         $ref: 'components.yaml#/components/responses/NotFound'
21     x-codegen-request-body-name: xpath
22
23   post:
24     tags:
25       - cps-data
26     summary: Create a node for a given anchor for the given dataspace
27     operationId: createNode
28     parameters:
29       - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
30       - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
31     requestBody:
32       required: true
33       content:
34         application/json:
35           schema:
36             type: string
37     responses:
38       201:
39         $ref: 'components.yaml#/components/responses/Created'
40       400:
41         $ref: 'components.yaml#/components/responses/BadRequest'
42       401:
43         $ref: 'components.yaml#/components/responses/Unauthorized'
44       403:
45         $ref: 'components.yaml#/components/responses/Forbidden'
46
47 nodesByDataspace:
48   get:
49     tags:
50       - cps-data
51     summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
52     operationId: getNode
53     parameters:
54       - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
55     responses:
56       200:
57         $ref: 'components.yaml#/components/responses/Ok'
58       400:
59         $ref: 'components.yaml#/components/responses/BadRequest'
60       401:
61         $ref: 'components.yaml#/components/responses/Unauthorized'
62       403:
63         $ref: 'components.yaml#/components/responses/Forbidden'
64       404:
65         $ref: 'components.yaml#/components/responses/NotFound'
66     x-codegen-request-body-name: requestBody