summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/api/swagger/cpsData.yml
blob: 97bf21a3e833e103f159593da02a0ed13649573f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
nodesByDataspaceAndAnchor:
  get:
    tags:
      - cps-data
    summary: Get a node given an anchor for the given dataspace
    operationId: getNodeByDataspaceAndAnchor
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
      - $ref: 'components.yaml#/components/parameters/xpathInQuery'
      - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
    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'
    x-codegen-request-body-name: xpath

  post:
    tags:
      - cps-data
    summary: Create a node for a given anchor for the given dataspace
    operationId: createNode
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: string
    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'

nodesByDataspace:
  get:
    tags:
      - cps-data
    summary: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT
    operationId: getNodeByDataspace
    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'
    x-codegen-request-body-name: requestBody