summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/api/swagger/cpsAdmin.yml
blob: d33c8e55ce06135e5d1fbc318898920b641d5bd8 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
dataspace:
  post:
    tags:
      - cps-admin
    summary: Create a new dataspace
    operationId: createDataspace
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInQuery'
    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'

dataspaceByDataspaceName:
  delete:
    tags:
      - cps-admin
    summary: Delete the given dataspace - DRAFT
    operationId: deleteDataspace
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
    responses:
      200:
        $ref: 'components.yaml#/components/responses/Ok'
      204:
        $ref: 'components.yaml#/components/responses/NoContent'
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'


schemaSet:
  post:
    tags:
      - cps-admin
    summary: Create a new schema set in the given dataspace
    operationId: createSchemaSet
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/schemaSetNameInQuery'
    requestBody:
      required: true
      content:
        multipart/form-data:
          schema:
            $ref: 'components.yaml#/components/schemas/MultipartFile'

    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'

schemaSetBySchemaSetName:
  get:
    tags:
      - cps-admin
    summary: Read a schema set given a schema set and a dataspace
    operationId: getSchemaSet
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/schemaSetNameInPath'
    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'
  delete:
    tags:
      - cps-admin
    summary: Delete schema set given a schema set and a dataspace
    operationId: deleteSchemaSet
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/schemaSetNameInPath'
    responses:
      204:
        $ref: 'components.yaml#/components/responses/NoContent'
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'
      409:
        $ref: 'components.yaml#/components/responses/Conflict'

anchorsByDataspace:
  get:
    tags:
      - cps-admin
    summary: Read all anchors, given a dataspace
    operationId: getAnchors
    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'

  post:
    tags:
      - cps-admin
    summary: Create a new anchor in the given dataspace
    operationId: createAnchor
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/schemaSetNameInQuery'
      - $ref: 'components.yaml#/components/parameters/anchorNameInQuery'
    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'

anchorByDataspaceAndAnchorName:
  get:
    tags:
      - cps-admin
    summary: Read an anchor given a anchor and a dataspace - DRAFT
    operationId: getAnchor
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
    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'

  delete:
    tags:
      - cps-admin
    summary: Delete an anchor given a anchor and a dataspace - DRAFT
    operationId: deleteAnchor
    parameters:
      - $ref: 'components.yaml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yaml#/components/parameters/anchorNameInPath'
    responses:
      200:
        $ref: 'components.yaml#/components/responses/Ok'
      204:
        $ref: 'components.yaml#/components/responses/NoContent'
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'