-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.json
More file actions
4208 lines (4208 loc) · 201 KB
/
Copy pathopenapi.json
File metadata and controls
4208 lines (4208 loc) · 201 KB
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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.2.0",
"info": {
"title": "ERNIE API",
"summary": "Read-only metadata, vocabulary, and citation endpoints for ERNIE integrations.",
"version": "1.0.0",
"description": "REST API for ERNIE (Earth Research Notary for Information Editing) - A metadata editor for reviewers of research data at GFZ Helmholtz Centre for Geosciences. This API provides read-only access to metadata types and controlled vocabularies for integration with ELMO and other external systems.",
"termsOfService": "https://ernie.rz-vm182.gfz.de/legal-notice",
"contact": {
"name": "Holger Ehrmann",
"url": "https://www.gfz.de/staff/holger.ehrmann/sec51",
"email": "ehrmann@gfz.de"
},
"license": {
"name": "GNU General Public License v3.0 or later",
"identifier": "GPL-3.0-or-later"
}
},
"externalDocs": {
"description": "ERNIE Project Documentation",
"url": "https://github.com/McNamara84/ernie"
},
"servers": [
{
"name": "Current ERNIE deployment",
"url": "https://ernie.rz-vm182.gfz.de",
"description": "The currently configured ERNIE instance"
}
],
"tags": [
{
"name": "Editor Configuration",
"summary": "Metadata types and editor option endpoints",
"description": "Endpoints for retrieving metadata types and roles configuration used by external editors like ELMO"
},
{
"name": "Vocabularies",
"summary": "Controlled vocabularies and availability endpoints",
"description": "Endpoints for accessing controlled vocabularies from NASA GCMD (Global Change Master Directory), PID registries (b2inst and RAiD), and ROR (Research Organization Registry)"
},
{
"name": "DataCite",
"summary": "Citation and DOI metadata lookup endpoints",
"description": "Endpoints for retrieving citation metadata and author information for DOIs via the DataCite API and doi.org Content Negotiation"
},
{
"name": "IGSN Imports",
"summary": "Authenticated IGSN import operations",
"description": "Session-authenticated endpoints for discovering legacy datacenter groups and starting IGSN imports from DataCite."
},
{
"name": "Portal",
"summary": "Public data portal endpoints",
"description": "Public endpoints used to discover published ERNIE resources."
}
],
"security": [],
"paths": {
"/api/v1/resource-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List resource types enabled for ELMO",
"description": "Returns all resource types that are enabled for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of resource types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElmoResourceType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/title-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List title types enabled for ELMO",
"responses": {
"200": {
"description": "List of title types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TitleType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
},
"description": "Returns all title types that are enabled for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
]
}
},
"/api/v1/licenses/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List licenses enabled for ELMO",
"responses": {
"200": {
"description": "List of licenses",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
}
},
"example": [
{
"id": 1,
"identifier": "CC-BY-4.0",
"name": "Creative Commons Attribution 4.0 International",
"uri": "https://creativecommons.org/licenses/by/4.0/",
"scheme_uri": "https://spdx.org/licenses/"
}
]
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
},
"description": "Returns all licenses that are enabled for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
]
}
},
"/api/v1/licenses/elmo/{resourceTypeSlug}": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List licenses enabled for ELMO filtered by resource type",
"description": "Returns all licenses that are enabled for ELMO and available for the specified resource type. Licenses that have the resource type in their exclusion list will not be returned. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"parameters": [
{
"name": "resourceTypeSlug",
"in": "path",
"required": true,
"description": "The slug of the resource type (e.g., 'software', 'dataset', 'book-chapter')",
"schema": {
"type": "string",
"example": "software"
}
}
],
"responses": {
"200": {
"description": "List of licenses available for the resource type",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
}
},
"example": [
{
"id": 1,
"identifier": "MIT",
"name": "MIT License",
"uri": "https://spdx.org/licenses/MIT.html",
"scheme_uri": "https://spdx.org/licenses/"
},
{
"id": 2,
"identifier": "GPL-3.0-or-later",
"name": "GNU General Public License v3.0 or later",
"uri": "https://spdx.org/licenses/GPL-3.0-or-later.html",
"scheme_uri": "https://spdx.org/licenses/"
}
]
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Resource type not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Resource type not found."
}
}
}
}
}
}
}
}
},
"/api/v1/date-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List date types enabled for ELMO",
"description": "Returns all date types that are enabled for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of date types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DateType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/description-types": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List all description types",
"description": "Returns all description types defined in the system, regardless of their activation status. No authentication required.",
"responses": {
"200": {
"description": "List of all description types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DescriptionType"
}
}
}
}
}
}
}
},
"/api/v1/description-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List description types enabled for ELMO",
"description": "Returns all description types that are enabled for ELMO (both `is_active` and `is_elmo_active` must be true). Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of description types enabled for ELMO",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DescriptionType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/description-types/ernie": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List description types enabled for ERNIE",
"description": "Returns all description types that are active for the ERNIE editor. No authentication required.",
"responses": {
"200": {
"description": "List of active description types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DescriptionType"
}
}
}
}
}
}
}
},
"/api/v1/languages/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List languages enabled for ELMO",
"responses": {
"200": {
"description": "List of languages",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
},
"description": "Returns all languages that are enabled for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
]
}
},
"/api/v1/roles/authors/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List author roles active for ELMO",
"description": "Returns all author roles that are active for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/roles/contributor-persons/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List contributor person roles active for ELMO",
"description": "Returns all contributor person roles that are active for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/roles/contributor-institutions/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List contributor institution roles active for ELMO",
"description": "Returns all contributor institution roles that are active for ELMO. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/relation-types": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List all relation types",
"description": "Returns all DataCite relation types defined in the system, regardless of their activation status. No authentication required.",
"responses": {
"200": {
"description": "List of all relation types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationType"
}
}
}
}
}
}
}
},
"/api/v1/relation-types/ernie": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List relation types enabled for ERNIE",
"description": "Returns all relation types that are active for the ERNIE editor (`is_active` is true). No authentication required.",
"responses": {
"200": {
"description": "List of active relation types",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationType"
}
}
}
}
}
}
}
},
"/api/v1/relation-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List relation types enabled for ELMO",
"description": "Returns all relation types that are enabled for ELMO (both `is_active` and `is_elmo_active` must be true). Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of relation types enabled for ELMO",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/identifier-types": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List all identifier types with patterns",
"description": "Returns all DataCite identifier types defined in the system with their active validation and detection regex patterns. Only patterns that are currently active are included. No authentication required.",
"responses": {
"200": {
"description": "List of all identifier types with active patterns",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentifierType"
}
}
}
}
}
}
}
},
"/api/v1/identifier-types/ernie": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List identifier types enabled for ERNIE",
"description": "Returns all identifier types that are active for the ERNIE editor (`is_active` is true) with their active patterns. No authentication required.",
"responses": {
"200": {
"description": "List of active identifier types with active patterns",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentifierType"
}
}
}
}
}
}
}
},
"/api/v1/identifier-types/elmo": {
"get": {
"tags": ["Editor Configuration"],
"summary": "List identifier types enabled for ELMO",
"description": "Returns all identifier types that are enabled for ELMO (both `is_active` and `is_elmo_active` must be true) with their active validation and detection regex patterns. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "List of identifier types enabled for ELMO with patterns",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentifierType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
},
"/api/v1/vocabularies/gcmd-science-keywords": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get GCMD Science Keywords vocabulary",
"description": "Returns the complete GCMD (Global Change Master Directory) Science Keywords vocabulary as a hierarchical JSON structure. The vocabulary is loaded from NASA's KMS (Keyword Management System) API. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "GCMD Science Keywords vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcmdScienceKeywords"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-gcmd-science-keywords"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/gcmd-platforms": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get GCMD Platforms vocabulary",
"description": "Returns the complete GCMD (Global Change Master Directory) Platforms vocabulary as a hierarchical JSON structure. The vocabulary is loaded from NASA's KMS (Keyword Management System) API. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "GCMD Platforms vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcmdPlatforms"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-gcmd-platforms"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/gcmd-instruments": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get GCMD Instruments vocabulary",
"description": "Returns the complete GCMD (Global Change Master Directory) Instruments vocabulary as a hierarchical JSON structure. The vocabulary is loaded from NASA's KMS (Keyword Management System) API. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "GCMD Instruments vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcmdInstruments"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-gcmd-instruments"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/msl-laboratories": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get MSL laboratories vocabulary",
"description": "Returns the locally stored Originating Multi-Scale Laboratories vocabulary with version metadata. Each laboratory contains the seven fields from the canonical Utrecht University vocabulary. Internal source and Git SHA metadata are never included. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "MSL laboratories vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MslLaboratoriesResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or the local vocabulary file is missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-msl-laboratories"
}
},
"required": ["error"]
}
}
}
},
"500": {
"description": "The local vocabulary file is unreadable or corrupted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "The local MSL laboratories vocabulary contains invalid JSON."
}
},
"required": ["error"]
}
}
}
}
}
}
},
"/api/v1/vocabularies/chronostrat-timescale": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get ICS Chronostratigraphic Timescale vocabulary",
"description": "Returns the International Chronostratigraphic Chart (ICS) as a hierarchical JSON structure. The vocabulary is loaded from the ARDC (Australian Research Data Commons) Linked Data API and contains geologic time intervals (eons, eras, periods, epochs, ages). Boundary and GSSP concepts are filtered out. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "ICS Chronostratigraphic Timescale vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChronostratTimescale"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-chronostrat-timescale"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/gemet": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get GEMET Thesaurus vocabulary",
"description": "Returns the GEMET (GEneral Multilingual Environmental Thesaurus) as a hierarchical JSON structure. The vocabulary is loaded from the EIONET GEMET REST API and contains environmental concepts organized in SuperGroups, Groups, and Concepts. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "GEMET Thesaurus vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GemetThesaurus"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-gemet-thesaurus"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/analytical-methods": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get Analytical Methods for Geochemistry vocabulary",
"description": "Returns the 'Analytical Methods for Geochemistry and Cosmochemistry' vocabulary as a hierarchical JSON structure. The vocabulary is loaded from the ARDC (Australian Research Data Commons) Linked Data API and contains analytical methods (e.g., Mass Spectrometry, ICP-MS) with notation codes and definitions. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "Analytical Methods vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalMethodsVocabulary"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-analytical-methods"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/euroscivoc": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get European Science Vocabulary (EuroSciVoc)",
"description": "Returns the European Science Vocabulary (EuroSciVoc) as a hierarchical JSON structure. EuroSciVoc is a taxonomy of fields of science based on OECD's 2015 Frascati Manual, extended with categories from CORDIS content. The vocabulary is published by the Publications Office of the European Union. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "EuroSciVoc vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EuroSciVocVocabulary"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or vocabulary file not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-euroscivoc"
}
}
}
}
}
}
}
}
},
"/api/v1/vocabularies/cgi-simple-lithology": {
"get": {
"tags": ["Vocabularies"],
"summary": "Get CGI Simple Lithology vocabulary",
"description": "Returns the CGI Simple Lithology vocabulary as a validated hierarchical JSON structure. ERNIE downloads the vocabulary from the official CGI vocabulary SPARQL API, preserves all paths of polyhierarchical concepts, and serves only the last successfully validated local copy. Provide the API key via the `X-API-Key` header.",
"security": [
{
"ElmoApiKey": []
}
],
"responses": {
"200": {
"description": "CGI Simple Lithology vocabulary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CgiSimpleLithologyVocabulary"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "Thesaurus is disabled or no validated local vocabulary is installed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Vocabulary file not found. Please run: php artisan get-cgi-simple-lithology"
}