-
-
Notifications
You must be signed in to change notification settings - Fork 52
/
schema.json
1134 lines (1134 loc) · 42.9 KB
/
schema.json
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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://bioregistry.io/schema.json",
"title": "Bioregistry JSON Schema",
"description": "The Bioregistry JSON Schema describes the shapes of the objects in the registry, metaregistry, collections, and their other related resources",
"definitions": {
"Author": {
"title": "Author",
"description": "Metadata for an author.",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the researcher",
"type": "string"
},
"orcid": {
"title": "Open Researcher and Contributor Identifier",
"description": "The Open Researcher and Contributor Identifier (ORCiD) provides researchers with an open, unambiguous identifier for connecting various digital assets (e.g., publications, reviews) across the semantic web. An account can be made in seconds at https://orcid.org.",
"pattern": "^\\d{4}-\\d{4}-\\d{4}-\\d{3}(\\d|X)$",
"type": "string"
},
"email": {
"title": "Email address",
"description": "The email address specific to the researcher.",
"type": "string"
},
"github": {
"title": "GitHub handle",
"description": "The GitHub handle enables contacting the researcher on GitHub: the *de facto* version control in the computer sciences and life sciences.",
"type": "string"
}
},
"required": [
"name",
"orcid"
]
},
"Collection": {
"title": "Collection",
"description": "A collection of resources.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "The collection's identifier",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the collection",
"type": "string"
},
"description": {
"title": "Description",
"description": "A description of the collection",
"type": "string"
},
"resources": {
"title": "Resources",
"description": "A list of prefixes of resources appearing in the collection",
"type": "array",
"items": {
"type": "string"
}
},
"authors": {
"title": "Authors",
"description": "A list of authors/contributors to the collection",
"type": "array",
"items": {
"$ref": "#/definitions/Author"
}
},
"context": {
"title": "Context",
"description": "The JSON-LD context's name",
"type": "string"
},
"references": {
"title": "References",
"description": "URL references",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"identifier",
"name",
"description",
"resources",
"authors"
]
},
"Provider": {
"title": "Provider",
"description": "A provider.",
"type": "object",
"properties": {
"code": {
"title": "Code",
"description": "A locally unique code within the prefix for the provider",
"type": "string"
},
"name": {
"title": "Name",
"description": "Name of the provider",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the provider",
"type": "string"
},
"homepage": {
"title": "Homepage",
"description": "Homepage of the provider",
"type": "string"
},
"uri_format": {
"title": "URI Format",
"description": "The URI format string, which must have at least one ``$1`` in it. Note that this field is generic enough to accept IRIs. See the URI specification (https://www.rfc-editor.org/rfc/rfc3986) and IRI specification (https://www.ietf.org/rfc/rfc3987.txt) for more information.",
"type": "string"
},
"first_party": {
"title": "First Party",
"description": "Annotates whether a provider is from the first-party organization",
"type": "boolean"
}
},
"required": [
"code",
"name",
"description",
"homepage",
"uri_format"
]
},
"Attributable": {
"title": "Attributable",
"description": "An upper-level metadata for a researcher.",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The full name of the researcher",
"type": "string"
},
"orcid": {
"title": "Open Researcher and Contributor Identifier",
"description": "The Open Researcher and Contributor Identifier (ORCiD) provides researchers with an open, unambiguous identifier for connecting various digital assets (e.g., publications, reviews) across the semantic web. An account can be made in seconds at https://orcid.org.",
"pattern": "^\\d{4}-\\d{4}-\\d{4}-\\d{3}(\\d|X)$",
"type": "string"
},
"email": {
"title": "Email address",
"description": "The email address specific to the researcher.",
"type": "string"
},
"github": {
"title": "GitHub handle",
"description": "The GitHub handle enables contacting the researcher on GitHub: the *de facto* version control in the computer sciences and life sciences.",
"type": "string"
}
},
"required": [
"name"
]
},
"Organization": {
"title": "Organization",
"description": "Model for organizataions.",
"type": "object",
"properties": {
"ror": {
"title": "Research Organization Registry identifier",
"description": "ROR identifier for a record about the organization",
"type": "string"
},
"wikidata": {
"title": "Wikidata identifier",
"description": "Wikidata identifier for a record about the organization",
"type": "string"
},
"name": {
"title": "Name",
"description": "Name of the organization",
"type": "string"
},
"partnered": {
"title": "Partnered",
"description": "Has this organization made a specific connection with Bioregistry?",
"default": false,
"type": "boolean"
}
},
"required": [
"name"
]
},
"Publication": {
"title": "Publication",
"description": "Metadata about a publication.",
"type": "object",
"properties": {
"pubmed": {
"title": "PubMed",
"description": "The PubMed identifier for the article",
"type": "string"
},
"doi": {
"title": "DOI",
"description": "The DOI for the article. DOIs are case insensitive, so these are required by the Bioregistry to be standardized to their lowercase form.",
"type": "string"
},
"pmc": {
"title": "PMC",
"description": "The PubMed Central identifier for the article",
"type": "string"
},
"title": {
"title": "Title",
"description": "The title of the article",
"type": "string"
},
"year": {
"title": "Year",
"description": "The year the article was published",
"type": "integer"
}
}
},
"Resource": {
"title": "Resource",
"description": "Metadata about an ontology, database, or other resource.",
"type": "object",
"properties": {
"prefix": {
"title": "Prefix",
"description": "The prefix for this resource",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the resource",
"type": "string"
},
"description": {
"title": "Description",
"description": "A description of the resource",
"type": "string"
},
"pattern": {
"title": "Pattern",
"description": "The regular expression pattern for local unique identifiers in the resource",
"type": "string"
},
"uri_format": {
"title": "URI format string",
"description": "The URI format string, which must have at least one ``$1`` in it. Note that this field is generic enough to accept IRIs. See the URI specification (https://www.rfc-editor.org/rfc/rfc3986) and IRI specification (https://www.ietf.org/rfc/rfc3987.txt) for more information.",
"type": "string"
},
"uri_format_resolvable": {
"title": "URI format string resolvable",
"description": "If false, denotes if the URI format string is known to be not resolvable",
"type": "boolean"
},
"rdf_uri_format": {
"title": "RDF URI format string",
"description": "The RDF URI format string, which must have at least one ``$1`` in it. Note that this field is generic enough to accept IRIs. See the URI specification (https://www.rfc-editor.org/rfc/rfc3986) and IRI specification (https://www.ietf.org/rfc/rfc3987.txt) for more information.",
"type": "string"
},
"providers": {
"title": "Providers",
"description": "Additional, non-default providers for the resource",
"type": "array",
"items": {
"$ref": "#/definitions/Provider"
}
},
"homepage": {
"title": "Homepage",
"description": "The URL for the homepage of the resource, preferably using HTTPS",
"type": "string"
},
"repository": {
"title": "Repository",
"description": "The URL for the repository of the resource",
"type": "string"
},
"contact": {
"title": "Contact",
"description": "The contact email address for the resource. This must correspond to a specific person and not be a listserve nor a shared email account.",
"allOf": [
{
"$ref": "#/definitions/Attributable"
}
]
},
"owners": {
"title": "Owners",
"description": "The owner of the corresponding identifier space. See also https://github.com/biopragmatics/bioregistry/issues/755.",
"type": "array",
"items": {
"$ref": "#/definitions/Organization"
}
},
"example": {
"title": "Example",
"description": "An example local identifier for the resource, explicitly excluding any redundant usage of the prefix in the identifier. For example, a GO identifier should only look like ``1234567`` and not like ``GO:1234567``",
"type": "string"
},
"example_extras": {
"title": "Example Extras",
"description": "Extra example identifiers",
"type": "array",
"items": {
"type": "string"
}
},
"example_decoys": {
"title": "Example Decoys",
"description": "Extra example identifiers that explicitly fail regex tests",
"type": "array",
"items": {
"type": "string"
}
},
"license": {
"title": "License",
"description": "The license for the resource",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version for the resource",
"type": "string"
},
"part_of": {
"title": "Part Of",
"description": "An annotation between this prefix and a super-prefix. For example, ``chembl.compound`` is a part of ``chembl``.",
"type": "string"
},
"provides": {
"title": "Provides",
"description": "An annotation between this prefix and a prefix for which it is redundant. For example, ``ctd.gene`` has been given a prefix by Identifiers.org, but it actually just reuses identifies from ``ncbigene``, so ``ctd.gene`` provides ``ncbigene``.",
"type": "string"
},
"download_owl": {
"title": "OWL Download URL",
"description": "The URL to download the resource as an ontology encoded in the OWL format. More information about this format can be found at https://www.w3.org/TR/owl2-syntax/.",
"type": "string"
},
"download_obo": {
"title": "OBO Download URL",
"description": "The URL to download the resource as an ontology encoded in the OBO format. More information about this format can be found at https://owlcollab.github.io/oboformat/doc/obo-syntax.html.",
"type": "string"
},
"download_json": {
"title": "OBO Graph JSON Download URL",
"description": "The URL to download the resource as an ontology encoded in the OBO Graph JSON format. More information about this format can be found at https://github.com/geneontology/obographs.",
"type": "string"
},
"download_rdf": {
"title": "RDF Download URL",
"description": "The URL to download the resource as an RDF file, in one of many formats.",
"type": "string"
},
"banana": {
"title": "Banana",
"description": "The `banana` is a generalization of the concept of the \"namespace embedded in local unique identifier\". Many OBO foundry ontologies use the redundant uppercased name of the ontology in the local identifier, such as the Gene Ontology, which makes the prefixes have a redundant usage as in ``GO:GO:1234567``. The `banana` tag explicitly annotates the part in the local identifier that should be stripped, if found. While the Bioregistry automatically knows how to handle all OBO Foundry ontologies' bananas because the OBO Foundry provides the \"preferredPrefix\" field, the banana can be annotated on non-OBO ontologies to more explicitly write the beginning part of the identifier that should be stripped. This allowed for solving one of the long-standing issues with the Identifiers.org resolver (e.g., for ``oma.hog``; see https://github.com/identifiers-org/identifiers-org.github.io/issues/155) as well as better annotate new entries, such as SwissMap Lipids, which have the prefix ``swisslipid`` but have the redundant information ``SLM:`` in the beginning of identifiers. Therefore, ``SLM:`` is the banana.",
"type": "string"
},
"banana_peel": {
"title": "Banana Peel",
"description": "Delimiter used in banana",
"type": "string"
},
"deprecated": {
"title": "Deprecated",
"description": "A flag denoting if this resource is deprecated. Currently, this is a blanket term that covers cases when the prefix is no longer maintained, when it has been rolled into another resource, when the website related to the resource goes down, or any other reason that it's difficult or impossible to find full metadata on the resource. If this is set to true, please add a comment explaining why. This flag will override annotations from the OLS, OBO Foundry, and others on the deprecation status, since they often disagree and are very conservative in calling dead resources.",
"type": "boolean"
},
"mappings": {
"title": "Mappings",
"description": "A dictionary of metaprefixes (i.e., prefixes for registries) to prefixes in external registries. These also correspond to the registry-specific JSON fields in this model like ``miriam`` field.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"synonyms": {
"title": "Synonyms",
"description": "A list of synonyms for the prefix of this resource. These are used in normalization of prefixes and are a useful reference tool for prefixes that are written many ways. For example, ``snomedct`` has many synonyms including typos like ``SNOWMEDCT``, lexical variants like ``SNOMED_CT``, version-variants like ``SNOMEDCT_2010_1_31``, and tons of other nonsense like ``SNOMEDCTCT``.",
"type": "array",
"items": {
"type": "string"
}
},
"keywords": {
"title": "Keywords",
"description": "A list of keywords for the resource",
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"title": "References",
"description": "A list of URLs to also see, such as publications describing the resource",
"type": "array",
"items": {
"type": "string"
}
},
"publications": {
"title": "Publications",
"description": "A list of URLs to also see, such as publications describing the resource",
"type": "array",
"items": {
"$ref": "#/definitions/Publication"
}
},
"appears_in": {
"title": "Appears In",
"description": "A list of prefixes that use this resource for xrefs, provenance, etc.",
"type": "array",
"items": {
"type": "string"
}
},
"depends_on": {
"title": "Depends On",
"description": "A list of prefixes that use this resource depends on, e.g., ontologies that import each other.",
"type": "array",
"items": {
"type": "string"
}
},
"namespace_in_lui": {
"title": "Namespace Embedded in Local Unique Identifier",
"description": "A flag denoting if the namespace is embedded in the LUI (if this is true and it is not accompanied by a banana, assume that the banana is the prefix in all caps plus a colon, as is standard in OBO). Currently this flag is only used to override identifiers.org in the case of ``gramene.growthstage``, ``oma.hog``, and ``vario``.",
"type": "boolean"
},
"no_own_terms": {
"title": "No Own Terms",
"description": "A flag denoting if the resource mints its own identifiers. Omission or explicit marking as false means that the resource does have its own terms. This is most applicable to ontologies, specifically application ontologies, which only reuse terms from others. One example is ChIRO.",
"type": "boolean"
},
"comment": {
"title": "Comment",
"description": "A field for a free text comment",
"type": "string"
},
"contributor": {
"title": "Contributor",
"description": "The contributor of the prefix to the Bioregistry, including at a minimum their name and ORCiD and optional their email address and GitHub handle. All entries curated through the Bioregistry GitHub Workflow must contain this field.",
"allOf": [
{
"$ref": "#/definitions/Author"
}
]
},
"contributor_extras": {
"title": "Contributor Extras",
"description": "Additional contributors besides the original submitter.",
"type": "array",
"items": {
"$ref": "#/definitions/Author"
}
},
"reviewer": {
"title": "Reviewer",
"description": "The reviewer of the prefix to the Bioregistry, including at a minimum their name and ORCiD and optional their email address and GitHub handle. All entries curated through the Bioregistry GitHub Workflow should contain this field pointing to the person who reviewed it on GitHub.",
"allOf": [
{
"$ref": "#/definitions/Author"
}
]
},
"proprietary": {
"title": "Proprietary",
"description": "A flag to denote if this database is proprietary and therefore can not be included in normal quality control checks nor can it be resolved. Omission or explicit marking as false means that the resource is not proprietary.",
"type": "boolean"
},
"has_canonical": {
"title": "Has Canonical",
"description": "If this shares an IRI with another entry, maps to which should be be considered as canonical",
"type": "string"
},
"preferred_prefix": {
"title": "Preferred Prefix",
"description": "An annotation of stylization of the prefix. This appears in OBO ontologies like FBbt as well as databases like NCBIGene. If it's not given, then assume that the normalized prefix used in the Bioregistry is canonical.",
"type": "string"
},
"twitter": {
"title": "Twitter",
"description": "The twitter handle for the project",
"type": "string"
},
"mastodon": {
"title": "Mastodon",
"description": "The mastodon handle for the project",
"type": "string"
},
"github_request_issue": {
"title": "Github Request Issue",
"description": "The GitHub issue for the new prefix request",
"type": "integer"
},
"logo": {
"title": "Logo",
"description": "The URL of the logo for the project/resource",
"type": "string"
},
"miriam": {
"title": "Miriam",
"type": "object"
},
"n2t": {
"title": "N2T",
"type": "object"
},
"prefixcommons": {
"title": "Prefixcommons",
"type": "object"
},
"wikidata": {
"title": "Wikidata",
"type": "object"
},
"go": {
"title": "Go",
"type": "object"
},
"obofoundry": {
"title": "Obofoundry",
"type": "object"
},
"bioportal": {
"title": "Bioportal",
"type": "object"
},
"ecoportal": {
"title": "Ecoportal",
"type": "object"
},
"agroportal": {
"title": "Agroportal",
"type": "object"
},
"cropoct": {
"title": "Cropoct",
"type": "object"
},
"ols": {
"title": "Ols",
"type": "object"
},
"aberowl": {
"title": "Aberowl",
"type": "object"
},
"ncbi": {
"title": "Ncbi",
"type": "object"
},
"uniprot": {
"title": "Uniprot",
"type": "object"
},
"biolink": {
"title": "Biolink",
"type": "object"
},
"cellosaurus": {
"title": "Cellosaurus",
"type": "object"
},
"ontobee": {
"title": "Ontobee",
"type": "object"
},
"cheminf": {
"title": "Cheminf",
"type": "object"
},
"fairsharing": {
"title": "Fairsharing",
"type": "object"
},
"biocontext": {
"title": "Biocontext",
"type": "object"
},
"edam": {
"title": "Edam",
"type": "object"
},
"re3data": {
"title": "Re3Data",
"type": "object"
},
"hl7": {
"title": "Hl7",
"type": "object"
},
"bartoc": {
"title": "BARTOC",
"type": "object"
},
"rrid": {
"title": "RRID",
"type": "object"
},
"lov": {
"title": "LOV",
"type": "object"
},
"zazuko": {
"title": "Zazuko",
"type": "object"
},
"togoid": {
"title": "Togoid",
"type": "object"
},
"integbio": {
"title": "Integbio",
"type": "object"
},
"pathguide": {
"title": "Pathguide",
"type": "object"
}
},
"required": [
"prefix"
]
},
"RegistrySchema": {
"title": "RegistrySchema",
"description": "Metadata about a registry's schema.",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "This field denotes if a name is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"homepage": {
"title": "Homepage",
"description": "This field denotes if a homepage is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"description": {
"title": "Description",
"description": "This field denotes if a description is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"example": {
"title": "Example",
"description": "This field denotes if an example local unique identifier is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"pattern": {
"title": "Pattern",
"description": "This field denotes if a regular expression pattern for matching local unique identifiers is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"provider": {
"title": "Provider",
"description": "This field denotes if a URI format string for converting local unique identifiers into URIs is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"alternate_providers": {
"title": "Alternate Providers",
"description": "This field denotes if additional/secondary URI format strings for converting local unique identifiers into URIs is required, optional, or never captured for each record in the registry.",
"enum": [
"present",
"missing"
],
"type": "string"
},
"synonyms": {
"title": "Synonyms",
"description": "This field denotes if alternative prefixes (e.g., taxonomy for NCBITaxon) is required, optional, or never captured for each record in the registry.",
"enum": [
"present",
"missing"
],
"type": "string"
},
"license": {
"title": "License",
"description": "This field denotes if capturing the data license is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"version": {
"title": "Version",
"description": "This field denotes if capturing the current data version is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"contact": {
"title": "Contact",
"description": "This field denotes if capturing the primary responsible person's contact information (e.g., name, ORCID, email) is required, optional, or never captured for each record in the registry.",
"enum": [
"required",
"required*",
"present",
"present*",
"missing"
],
"type": "string"
},
"search": {
"title": "Prefix Search",
"description": "This field denotes if the registry provides either a dedicated page for searching for prefixes (e.g. AberOWL has a dedicated search page) OR a contextual search (e.g., AgroPortal has a prefix search built in its homepage).",
"type": "boolean"
}
},
"required": [
"name",
"homepage",
"description",
"example",
"pattern",
"provider",
"alternate_providers",
"synonyms",
"license",
"version",
"contact",
"search"
]
},
"RegistryQualities": {
"title": "RegistryQualities",
"description": "Qualities about a registry.",
"type": "object",
"properties": {
"structured_data": {
"title": "Structured Data",
"description": "This field denotes if the registry provides structured access to its data? For example, this can be through an API (e.g., FAIRsharing, OLS) or a bulk download (e.g., OBO Foundry) in a structured file format. A counter-example is a site that must be scraped to acquire its content (e.g, the NCBI GenBank).",
"type": "boolean"
},
"bulk_data": {
"title": "Bulk Data",
"description": "This field denotes if the registry provides a bulk dump of its data? For example, the OBO Foundry provides its bulk data in a file and Identifiers.org provides its bulk data in an API endpoint. A counterexample is FAIRsharing, which requires slow, expensive pagination through its data. Another counterexample is HL7 which requires manually navigating a form to download its content. While GenBank is not structured, it is still bulk downloadable.",
"type": "boolean"
},
"no_authentication": {
"title": "No Authentication",
"description": "This field denotes if the registry provides access to its data without an API key? For example, Identifiers.org. As a counter-example, BioPortal requires an API key for access to its structured data.",
"type": "boolean"
},
"automatable_download": {
"title": "Automatable Download",
"description": "This field denotes if the registry makes its data available downloadable in an automated way?This includes websites that have bulk downloads, paginated API downloads, or even require scraping.A counter example is HL7, whose download can not be automated due to the need to interact with a web form.",
"default": true,
"type": "boolean"
}
},
"required": [
"structured_data",
"bulk_data",
"no_authentication"
]
},
"RegistryGovernance": {
"title": "RegistryGovernance",
"description": "Metadata about a registry's governance.",
"type": "object",
"properties": {
"curation": {
"title": "Curation",
"enum": [
"private",
"import",
"community",
"opaque-review",
"open-review"
],
"type": "string"
},
"curates": {
"title": "Curates",
"description": "This field denotes if the registry's maintainers and potentially contributors curate novel prefixes.",
"type": "boolean"
},
"imports": {
"title": "Imports",
"description": "This field denotes if the registry imports and aligns prefixes from other registries.",
"type": "boolean"
},
"scope": {
"title": "Scope",
"description": "This field denotes the scope of prefixes which the registry covers. For example, some registries are limited to ontologies, some have a full scope over the life sciences, and some are general purpose.",
"type": "string"
},
"comments": {
"title": "Comments",
"description": "Optional additional comments about the registry's governance model",
"type": "string"
},
"accepts_external_contributions": {
"title": "Accepts External Contributions",
"description": "This field denotes if the registry (in theory) accepts external contributions, either via suggestion or proactive improvement. This field does not pass judgement on the difficult of this process from the perspective of the submitter nor the responsiveness of the registry. This field does not consider the ability for insiders (i.e., people with private relationships to the maintainers) to affect change.",
"type": "boolean"
},
"public_version_controlled_data": {
"title": "Public Version-Controlled Data",
"description": "This field denotes if the registry stores its data in publicly available version control system, such as GitHub or GitLab",
"type": "boolean"
},
"data_repository": {
"title": "Data Repository",
"description": "This field denotes the address of the registry's data version control repository.",
"type": "string"
},
"code_repository": {
"title": "Code Repository",
"description": "This field denotes the address of the registry's code version control repository.",
"type": "string"
},
"review_team": {
"title": "Review Team",
"description": "This field denotes if the registry's reviewers/moderators for external contributions known? If there's a well-defined, maintained listing, then it can be marked as public. If it can be inferred, e.g. from reading the commit history on a version control system, then it can be marked as inferrable. A closed review team, e.g., like for Identifiers.org can be marked as private. Resources that do not accept external contributions can be marked with N/A. An unmoderated regitry like Prefix.cc is marked with 'democratic'.",
"enum": [
"public",
"inferrable",
"private",
"democratic",
"n/a"
],
"type": "string"
},
"status": {
"title": "Status",
"description": "This field denotes the maitenance status of the repository. An active repository is still being maintained and also is responsive to external requests for improvement. An unresponsive repository is still being maintained in some capacity but is not responsive to external requests for improvement. An inactive repository is no longer being proactively maintained (though may receive occasional patches).",
"enum": [
"active",
"unresponsive",
"inactive"
],
"type": "string"
},
"issue_tracker": {
"title": "Issue Tracker",
"description": "This field denotes the public issue tracker for issues related to the code and data of the repository.",
"type": "string"
}
},
"required": [
"curation",
"curates",
"imports",
"scope",
"accepts_external_contributions",
"public_version_controlled_data",
"review_team",
"status"
]
},
"Registry": {
"title": "Registry",
"description": "Metadata about a registry.",
"type": "object",
"properties": {
"prefix": {
"title": "Prefix",
"description": "The metaprefix for the registry itself. For example, the metaprefix for Identifiers.org is `miriam`.",
"type": "string"
},
"name": {
"title": "Name",
"description": "The human-readable label for the registry",
"type": "string"
},
"description": {
"title": "Description",
"description": "A full description of the registry.",
"type": "string"
},
"homepage": {
"title": "Homepage",
"description": "The URL for the homepage of the registry.",
"type": "string"
},
"example": {
"title": "Example",
"description": "An example prefix inside the registry.",
"type": "string"
},
"bibtex": {
"title": "Bibtex",
"description": "Citation key used in BibTex for this registry.",
"type": "string"
},
"availability": {
"title": "Availability",
"description": "A structured description of the metadata that the registry collects",
"allOf": [
{
"$ref": "#/definitions/RegistrySchema"
}
]
},
"qualities": {
"title": "Qualities",
"description": "A structured description of the registry's qualities",
"allOf": [
{
"$ref": "#/definitions/RegistryQualities"
}
]
},
"governance": {
"title": "Governance",
"description": "A structured description of the governance for the registry",
"allOf": [
{
"$ref": "#/definitions/RegistryGovernance"
}
]
},
"download": {
"title": "Download",
"description": "A download link for the data contained in the registry",
"type": "string"
},
"provider_uri_format": {
"title": "Provider Uri Format",
"description": "A URL with a $1 for a prefix to resolve in the registry",
"type": "string"
},
"search_uri_format": {
"title": "Search Uri Format",
"description": "A URL with a $1 for a prefix or string for searching for prefixes",
"type": "string"
},
"resolver_uri_format": {