Newer
Older
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
openapi: "3.1.0"
info:
version: '0.1'
title: 'FDO Manager Service API'
description: "The FDO Manager Service API for creating FAIR Digital Objects."
contact:
name: IndiScale GmbH
email: t.fitschen@indiscale.com
url: https://www.indiscale.com
servers:
- url: http://localhost:8080
tags:
- name: Repositories
description: Repositories for storing FDO data and metadata.
- name: Profiles
description: FDO Profiles specify the attributes of FDOs.
- name: Logging
description: Logging of operations handled by this FDO Manager Service Instance.
- name: FDOs
description: Fair Digital Objects.
- name: Info
description: General information about the Service.
paths:
/logging:
get:
tags:
- Logging
description: "List latest log events"
operationId: listLogEvents
parameters:
- in: query
name: "page[number]"
schema:
type: integer
default: 0
- in: query
name: "page[size]"
schema:
type: integer
default: 100
responses:
"200":
description: "Success."
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OperationsLogRecord'
links:
$ref: '#/components/schemas/PaginationLinks'
meta:
$ref: '#/components/schemas/PaginationMeta'
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/profiles:
get:
tags:
- Profiles
description: "List known profiles."
operationId: listProfiles
responses:
"200":
description: "Success."
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Profile'
links:
$ref: '#/components/schemas/Links'
/profiles/{profileId}:
get:
tags:
- Profiles
description: "Get information on a single profile."
operationId: getProfile
parameters:
- name: profileId
in: path
description: "Profile ID"
required: true
schema:
$ref: '#/components/schemas/ProfileID'
responses:
"200":
description: "Success."
content:
application/json:
schema:
type: object
required: ["data"]
properties:
data:
$ref: '#/components/schemas/Profile'
links:
$ref: '#/components/schemas/Links'
"404":
description: "Unknown profile id."
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/hello:
get:
tags:
- Info
description: Say hello to the server.
operationId: hello
responses:
"200":
description: A hello from the server.
content:
application/json:
schema:
$ref: '#/components/schemas/Hello'
/info:
get:
tags:
- Info
description: Retrieve general information on the service.
operationId: getInfo
responses:
"200":
description: General service information.
content:
application/json:
schema:
type: object
required: ["data"]
properties:
data:
$ref: "#/components/schemas/Info"
links:
$ref: '#/components/schemas/Links'
/repositories:
get:
tags:
- Repositories
description: "List trusted repositories."
operationId: listRepositories
responses:
"200":
description: "Success."
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Repository'
links:
$ref: '#/components/schemas/Links'
/repositories/{repositoryId}:
get:
tags:
- Repositories
description: "Get information on a single repository."
operationId: getRepository
parameters:
- name: repositoryId
in: path
description: "Repository ID"
required: true
schema:
$ref: '#/components/schemas/RepositoryID'
responses:
"200":
description: "Success."
content:
application/json:
schema:
type: object
required: ["data"]
properties:
data:
$ref: '#/components/schemas/Repository'
links:
$ref: '#/components/schemas/Links'
"404":
description: "Unknown repository id."
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/fdo:
post:
tags:
- FDOs
description: "Create an FDO."
operationId: createFDO
requestBody:
content:
multipart/form-data:
schema:
type: object
required: ["repositories", "data", "metadata"]
properties:
repositories:
$ref: "#/components/schemas/TargetRepositories"
data:
type: string
format: binary
metadata:
type: string
format: binary
responses:
"201":
description: "The Location header points to the newly created FDO."
/fdo/{prefix}/{suffix}:
get:
tags:
- FDOs
description: "Resolve a pid."
operationId: "resolvePID"
parameters:
- $ref: '#/components/parameters/Prefix'
- $ref: '#/components/parameters/Suffix'
responses:
"200":
description: "A successfully resolved pid."
content:
application/json:
schema:
type: object
required: ["data"]
properties:
data:
$ref: '#/components/schemas/DigitalObject'
links:
$ref: '#/components/schemas/Links'
"404":
description: "Could not resolve pid."
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
tags:
- FDOs
description: "Delete an FDO."
operationId: permanentlyDeleteFDO
parameters:
- $ref: '#/components/parameters/Prefix'
- $ref: '#/components/parameters/Suffix'
responses:
description: "FDO deleted successfully."
"404":
description: "Could not resolve pid."
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
OperationsLogRecord:
type: object
properties:
id:
type: string
type:
type: string
const: "OperationsLogRecord"
attributes:
type: object
properties:
operation:
type: string
enum: ["Op.Create", "Op.Delete"]
timestamp:
type: string
format: date-time
repositories:
$ref: '#/components/schemas/TargetRepositories'
fdo:
$ref: '#/components/schemas/DigitalObject'
links:
$ref: '#/components/schemas/SelfLink'
TargetRepositories:
type: object
properties:
fdo:
description: "ID of the repository where you want to store the FDO"
description: "ID of the repository where you want to store the metadata"
description: "ID of the repository where you want to store the data"
type: string
SelfLink:
type: object
properties:
self:
type: string
nullable: true
PaginationMeta:
type: object
properties:
items_total:
type: number
format: int32
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
PaginationLinks:
type: object
properties:
self:
type: string
format: uri
first:
type: string
format: uri
prev:
type: string
format: uri
next:
type: string
format: uri
last:
type: string
format: uri
Links:
type: object
properties:
self:
type: string
nullable: true
collection:
type: string
nullable: true
Error:
type: object
required: ["detail", "status"]
properties:
detail:
type: string
nullable: true
status:
type: string
nullable: true
RepositoryID:
type: string
examples:
- "gwdg-cordra-1"
- "fdo.indiscale.com"
- "b2share@gwdg"
Repository:
type: object
properties:
id:
$ref: '#/components/schemas/RepositoryID'
type:
type: string
description:
type: string
maintainer:
type: string
attributes:
type: object
additionalProperties: true
links:
$ref: '#/components/schemas/Links'
ProfileID:
type: string
Profile:
type: object
properties:
id:
$ref: '#/components/schemas/ProfileID'
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
links:
$ref: '#/components/schemas/Links'
Hello:
type: object
properties:
message:
type: string
example: 'Hello marie.curie@sorbonne-universite.fr. This is FDO Manager Service v0.1-SNAPSHOT/API v0.1'
default: 'Hello anonymous. This is FDO Manager Service v0.1-SNAPSHOT/API v0.1'
DigitalObject:
type: object
required: ["pid", "isFdo"]
properties:
pid:
type: string
isFdo:
type: boolean
dataPid:
type: string
metadataPid:
type: string
Info:
type: object
properties:
fdoServiceVersion:
type: string
fdoSdkVersion:
type: string
serviceProvider:
type: string
links:
$ref: '#/components/schemas/SelfLink'
parameters:
Prefix:
name: prefix
in: path
description: "Persistent Identifier Prefix"
required: true
schema:
type: string
Suffix:
name: suffix
in: path
description: "Persistent Identifier Suffix"
required: true
schema:
type: string