-
Notifications
You must be signed in to change notification settings - Fork 36
/
swagger.yaml
597 lines (596 loc) · 17.1 KB
/
swagger.yaml
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
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
openapi: 3.0.1
info:
title: F-UJI
description: A Service for Evaluating Research Data Objects Based on <a href ='https://doi.org/10.5281/zenodo.3775793'>FAIRsFAIR
Metrics</a>. <p> This work was supported by the <a href='https://www.fairsfair.eu/'>FAIRsFAIR</a>
project (H2020-INFRAEOSC-2018-2020 Grant Agreement 831558).
contact:
email: adevaraju@marum.de
license:
name: MIT License
url: https://opensource.org/licenses/MIT
version: 1.0.0
externalDocs:
description: Find out more about F-UJI
url: https://github.com/pangaea-data-publisher/fuji
servers:
- url: https://localhost:1071/fuji/api/v1
description: Development Server
security:
- UserLogin: []
tags:
- name: FAIR object
description: FAIRness assessment of a data object
- name: FAIR metric
description: FAIRsFAIR assessment metrics
paths:
/evaluate:
post:
tags:
- FAIR object
description: Evaluate FAIRness of a data object based on its identifier
operationId: assess_by_id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/body'
example:
object_identifier: https://doi.org/10.1594/PANGAEA.908011
test_debug: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FAIRResults'
"400":
description: Invalid identifier supplied
"401":
description: Authentication information is missing or invalid
headers:
WWW_Authenticate:
style: simple
explode: false
schema:
type: string
"404":
description: Object not found
x-openapi-router-controller: fuji_server.controllers.fair_object_controller
/metrics:
get:
tags:
- FAIR metric
summary: Return all metrics and their definitions
operationId: get_metrics
responses:
"200":
description: Metrics are successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Metrics'
"400":
description: Invalid request supplied
"401":
description: Authentication information is missing or invalid
headers:
WWW_Authenticate:
style: simple
explode: false
schema:
type: string
"404":
description: Object not found
x-openapi-router-controller: fuji_server.controllers.fair_metric_controller
components:
schemas:
FAIRResults:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Uniqueness'
- $ref: '#/components/schemas/Persistence'
- $ref: '#/components/schemas/CoreMetadata'
- $ref: '#/components/schemas/IdentifierIncluded'
- $ref: '#/components/schemas/Searchable'
- $ref: '#/components/schemas/DataAccessLevel'
- $ref: '#/components/schemas/FormalMetadata'
- $ref: '#/components/schemas/SemanticVocabulary'
- $ref: '#/components/schemas/RelatedResource'
- $ref: '#/components/schemas/DataContentMetadata'
- $ref: '#/components/schemas/License'
- $ref: '#/components/schemas/DataProvenance'
- $ref: '#/components/schemas/CommunityEndorsedStandard'
- $ref: '#/components/schemas/DataFileFormat'
FAIRResultCommon:
required:
- id
- metric_identifier
- metric_name
- score
- test_status
type: object
properties:
id:
type: integer
format: int32
metric_identifier:
type: string
metric_name:
type: string
test_status:
type: string
default: fail
enum:
- pass
- fail
- indeterminate
score:
$ref: '#/components/schemas/FAIRResultCommon_score'
Uniqueness:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/Uniqueness_output'
test_debug:
$ref: '#/components/schemas/Debug'
Persistence:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/Persistence_output'
test_debug:
$ref: '#/components/schemas/Debug'
CoreMetadata:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/CoreMetadata_output'
test_debug:
$ref: '#/components/schemas/Debug'
IdentifierIncluded:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/IdentifierIncluded_output'
test_debug:
$ref: '#/components/schemas/Debug'
Searchable:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/Searchable_output'
test_debug:
$ref: '#/components/schemas/Debug'
License:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/License_output'
test_debug:
$ref: '#/components/schemas/Debug'
DataAccessLevel:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/DataAccess_output'
test_debug:
$ref: '#/components/schemas/Debug'
RelatedResource:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/RelatedResource_output'
test_debug:
$ref: '#/components/schemas/Debug'
CommunityEndorsedStandard:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/CommunityEndorsedStandard_output'
test_debug:
$ref: '#/components/schemas/Debug'
DataFileFormat:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/DataFileFormat_output'
test_debug:
$ref: '#/components/schemas/Debug'
DataProvenance:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/DataProvenance_output'
test_debug:
$ref: '#/components/schemas/Debug'
DataContentMetadata:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/DataContentMetadata_output'
test_debug:
$ref: '#/components/schemas/Debug'
FormalMetadata:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/FormalMetadata_output'
test_debug:
$ref: '#/components/schemas/Debug'
SemanticVocabulary:
allOf:
- $ref: '#/components/schemas/FAIRResultCommon'
- type: object
properties:
output:
$ref: '#/components/schemas/SemanticVocabulary_output'
test_debug:
$ref: '#/components/schemas/Debug'
FAIRResultCommon_score:
type: object
properties:
earned:
type: integer
format: int32
default: 0
total:
type: integer
format: int32
default: 0
Uniqueness_output:
type: object
properties:
guid:
type: string
guid_scheme:
type: string
Persistence_output:
type: object
properties:
pid:
type: string
pid_scheme:
type: string
resolvable_status:
type: boolean
default: false
resolved_url:
type: string
output_core_metadata_found:
required:
- creator
- keywords
- object_identifier
- publication_date
- publisher
- summary
- title
type: object
properties:
creator:
type: array
items:
type: string
title:
type: string
publisher:
type: string
publication_date:
type: string
format: date
summary:
type: string
keywords:
type: string
object_identifier:
type: string
CoreMetadata_output:
type: object
properties:
core_metadata_status:
type: string
enum:
- no metadata
- partial metadata
- all metadata
core_metadata_found:
$ref: '#/components/schemas/output_core_metadata_found'
core_metadata_source:
type: array
items:
type: string
IdentifierIncluded_output:
type: object
properties:
object_identifier_included:
type: string
content:
type: array
items:
$ref: '#/components/schemas/IdentifierIncluded_output_inner'
output_search_mechanisms:
type: object
properties:
mechanism:
type: string
enum:
- metadata registry
- structured data
mechanism_info:
type: array
items:
type: string
Searchable_output:
type: object
properties:
search_mechanisms:
type: array
items:
$ref: '#/components/schemas/output_search_mechanisms'
License_output:
type: array
items:
$ref: '#/components/schemas/License_output_inner'
DataAccess_output:
type: object
properties:
access_level:
type: string
enum:
- public
- embargoed
- restricted
- closed_metadataonly
access_details:
type: object
RelatedResource_output:
type: array
items:
$ref: '#/components/schemas/RelatedResource_output_inner'
DataFileFormat_output:
type: array
items:
$ref: '#/components/schemas/DataFileFormat_output_inner'
CommunityEndorsedStandard_output:
type: array
items:
$ref: '#/components/schemas/CommunityEndorsedStandard_output_inner'
DataProvenance_output:
type: object
properties:
creation_provenance_included:
$ref: '#/components/schemas/DataProvenance_output_inner'
modification_provenance_included:
$ref: '#/components/schemas/DataProvenance_output_inner'
provenance_relations_included:
$ref: '#/components/schemas/DataProvenance_output_inner'
structured_provenance_available:
$ref: '#/components/schemas/DataProvenance_output_inner'
DataContentMetadata_output:
type: object
properties:
object_type:
type: string
data_content_descriptor:
type: array
items:
$ref: '#/components/schemas/DataContentMetadata_output_inner'
FormalMetadata_output:
type: array
items:
$ref: '#/components/schemas/FormalMetadata_output_inner'
SemanticVocabulary_output:
type: array
items:
$ref: '#/components/schemas/SemanticVocabulary_output_inner'
Metrics:
type: object
properties:
total:
type: integer
metrics:
type: array
items:
$ref: '#/components/schemas/Metric'
example:
total: 0
metrics:
metric_identifier: FsF-F1-01D
metric_short_name: Globally Unique Identifier
metric_name: Data is assigned with a globally unique identifier.
description: A data object may be assigned with a globally unique identifier such that it can be referenced unambiguously by humans or machines. Globally unique means an identifier should be associated with only one resource at any time. Examples of unique identifiers of data are Internationalized Resource Identifier (IRI), Uniform Resource Identifier (URI) such as URL and URN, Digital Object Identifier (DOI), the Handle System, identifiers.org, w3id.org and Archival Resource Key (ARK). A data repository may assign a globally unique identifier to your data or metadata when you publish and make it available through their services.
fair_principle: F1
evaluation_mechanism: Identifier is considered unique if it is successfully validated through https://pythonhosted.org/IDUtils/. Supported schemes are ISBN10, ISBN13, ISSN, ISTC, DOI, Handle, EAN8, EAN13, ISNI ORCID, ARK, PURL, LSID, URN, Bibcode, arXiv, PubMed ID, PubMed Central ID, GND.
created_by: FAIRsFAIR
date_created: 2020-07-08
date_updated: 2020-07-08
version: 0.3
total_score: 1
Metric:
type: object
properties:
metric_identifier:
type: string
metric_name:
type: string
description:
type: string
fair_principle:
type: string
evaluation_mechanism:
type: string
date_created:
type: string
format: date
date_updated:
type: string
format: date
created_by:
type: string
version:
type: number
format: double
total_score:
type: integer
format: int32
Debug:
type: array
items:
type: string
body:
required:
- object_identifier
type: object
properties:
object_identifier:
type: string
description: The full identifier of data object that needs to be evaluated
test_debug:
type: boolean
description: Indicate if the detailed evaluation procedure of the metrics
should to be included in the response
default: false
IdentifierIncluded_output_inner:
type: object
properties:
content_identifier_included:
type: string
content_identifier_active:
type: boolean
default: false
License_output_inner:
type: object
properties:
license:
type: string
OSI_approved:
type: boolean
default: false
details_url:
type: string
RelatedResource_output_inner:
type: object
properties:
related_resource:
type: string
relation_type:
type: string
CommunityEndorsedStandard_output_inner:
type: object
properties:
metadata_standard:
type: string
urls:
type: array
items:
type: string
subject_areas:
type: array
items:
type: string
DataFileFormat_output_inner:
type: object
properties:
file_uri:
type: string
mime_type:
type: string
is_preferred_format:
type: boolean
default: false
preference_reason:
type: array
items:
type: string
subject_areas:
type: array
items:
type: string
DataProvenance_output_inner:
type: object
properties:
is_available:
type: boolean
default: true
provenance_metadata:
type: array
items:
type: object
additionalProperties:
type: string
DataContentMetadata_output_inner:
type: object
properties:
descriptor:
type: string
descriptor_value:
type: string
matches_content:
type: boolean
default: false
FormalMetadata_output_inner:
type: object
properties:
serialization_format:
type: string
source:
type: string
enum:
- typed_link
- content_negotiate
- structured_data
- sparql_endpoint
is_metadata_found:
type: boolean
default: false
SemanticVocabulary_output_inner:
type: object
properties:
namespace:
type: string
is_namespace_active:
type: boolean
default: false
responses:
UnauthorizedError:
description: Authentication information is missing or invalid
headers:
WWW_Authenticate:
style: simple
explode: false
schema:
type: string
securitySchemes:
UserLogin:
type: http
scheme: basic
x-basicInfoFunc: fuji_server.controllers.authorization_controller.check_UserLogin