Skip to content

Commit 66aae4b

Browse files
author
Guy Davenport
committed
Added missing descriptions and some minor changes in Schema
1 parent 59d4bb8 commit 66aae4b

20 files changed

Lines changed: 83 additions & 54 deletions

Specification/BrAPI-Schema/BrAPI-Common/AdditionalInfo.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22
"$defs": {
33
"AdditionalInfo": {
44
"additionalProperties": {
5-
"type": "string"
5+
"description": "A free space containing any additional information related to a particular object.",
6+
"type": [
7+
"null",
8+
"string"
9+
]
610
},
711
"description": "A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.",
812
"title": "AdditionalInfo",
9-
"type": "object"
13+
"type": [
14+
"null",
15+
"object"
16+
]
1017
}
1118
},
1219
"$id": "https://brapi.org/Specification/BrAPI-Schema/Components/Common/AdditionalInfo.json",

Specification/BrAPI-Schema/BrAPI-Core/DataLink.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"$defs": {
33
"DataLink": {
4+
"description": "A link to a data file associated with a study. Extra data could include notes, images, and reference data. Based on the MIAPPE V1.1 (DM-38) Data file description.",
45
"properties": {
56
"dataFormat": {
67
"description": "The structure of the data within a file. For example - VCF, table, image archive, multispectral image archives in EDAM ontology (used in Galaxy)\n\nMIAPPE V1.1 (DM-38) Data file description - Description of the format of the data file. May be a standard file format name, or a description of organization of the data in a tabular file.",

Specification/BrAPI-Schema/BrAPI-Core/List.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,10 @@
102102
"title": "List",
103103
"type": "object",
104104
"brapi-metadata": {
105-
"primaryModel": true
105+
"primaryModel": true,
106+
"subQuery": [
107+
"data"
108+
]
106109
}
107110
}
108111
},

Specification/BrAPI-Schema/BrAPI-Core/Study.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,8 @@
6868
"environmentParameters": {
6969
"description": "Environmental parameters that were kept constant throughout the study and did not change between observation units.\n\nMIAPPE V1.1 (DM-57) Environment - Environmental parameters that were kept constant throughout the study and did not change between observation units or assays. Environment characteristics that vary over time, i.e. environmental variables, should be recorded as Observed Variables (see below).",
7070
"relationshipType": "one-to-many",
71-
"referencedAttribute": "study",
7271
"items": {
73-
"$ref": "../BrAPI-Core/Study.json#/$defs/EnvironmentParameters",
74-
"description": "EnvironmentParameters"
72+
"$ref": "../BrAPI-Core/Study.json#/$defs/EnvironmentParameter"
7573
},
7674
"title": "EnvironmentParameters",
7775
"type": [
@@ -321,7 +319,8 @@
321319
"primaryModel": true
322320
}
323321
},
324-
"EnvironmentParameters": {
322+
"EnvironmentParameter": {
323+
"description": "An environmental parameter that were kept constant throughout the study and did not change between observation units.\n\nMIAPPE V1.1 (DM-57) Environment - Environmental parameters that were kept constant throughout the study and did not change between observation units or assays. Environment characteristics that vary over time, i.e. environmental variables, should be recorded as Observed Variables.",
325324
"properties": {
326325
"description": {
327326
"description": "Human-readable value of the environment parameter (defined above) constant within the experiment",
@@ -453,13 +452,15 @@
453452
"type": "string"
454453
},
455454
"timestamp": {
455+
"description": "The timestamp of the update.",
456456
"format": "date-time",
457457
"type": [
458458
"null",
459459
"string"
460460
]
461461
},
462462
"version": {
463+
"description": "The version of the update.",
463464
"type": [
464465
"null",
465466
"string"

Specification/BrAPI-Schema/BrAPI-Core/Trial.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@
191191
}
192192
},
193193
"DatasetAuthorships": {
194+
"description": "License and citation information for the data a trial",
194195
"properties": {
195196
"datasetPUI": {
196197
"description": "The DOI or other permanent unique identifier for this published dataset",
@@ -234,14 +235,17 @@
234235
}
235236
},
236237
"Publication": {
238+
"description": "MIAPPE V1.1 (DM-9) Associated publication - An identifier for a literature publication where the investigation is described. Use of DOIs is recommended.",
237239
"properties": {
238240
"publicationPUI": {
241+
"description": "The permanent unique identifier of the publication.",
239242
"type": [
240243
"null",
241244
"string"
242245
]
243246
},
244247
"publicationReference": {
248+
"description": "The publication reference.",
245249
"type": [
246250
"null",
247251
"string"

Specification/BrAPI-Schema/BrAPI-Genotyping/AlleleMatrix.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@
155155
}
156156
},
157157
"Pagination": {
158+
"description": "Allows for the pagination of large matrices.",
158159
"properties": {
159160
"dimension": {
160161
"description": "The dimension of the matrix being paginated",

Specification/BrAPI-Schema/BrAPI-Genotyping/Call.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
}
6767
},
6868
"GenotypeMetadata": {
69+
"description": "An additional layer of metadata associated with a genotype",
6970
"properties": {
7071
"dataType": {
7172
"description": "The type of field represented in this Genotype Field. This is intended to help parse the data out of JSON.",

Specification/BrAPI-Schema/BrAPI-Genotyping/MarkerPosition.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"$defs": {
33
"MarkerPosition": {
4+
"description": "The position of a marker or variant within a `LinkageGroup`. A marker or variant may be positioned on more than one Linkage Group or Genome Map.",
45
"properties": {
56
"additionalInfo": {
67
"description": "A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.",

Specification/BrAPI-Schema/BrAPI-Germplasm/Cross.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@
6565
},
6666
"plannedCross": {
6767
"$ref": "PlannedCross.json#/$defs/PlannedCross",
68-
"description": "the unique identifier for a planned cross",
68+
"description": "The Planned Cross that was using in the planning of this Cross.",
6969
"referencedAttribute": "crosses",
7070
"relationshipType": "many-to-one"
7171
},
7272
"pollinationEvents": {
73-
"description": "The list of pollination events that occurred for this cross",
73+
"description": "The list of pollination events that occurred for this cross.",
7474
"relationshipType": "one-to-many",
7575
"referencedAttribute": "cross",
7676
"items": {
@@ -108,6 +108,7 @@
108108
}
109109
},
110110
"CrossAttribute": {
111+
"description": "An attribute of a Cross.",
111112
"properties": {
112113
"crossAttributeName": {
113114
"description": "the human readable name of a cross attribute",
@@ -137,6 +138,7 @@
137138
}
138139
},
139140
"PollinationEvent": {
141+
"description": "A Pollination Event that was used or attempted for a Cross.",
140142
"properties": {
141143
"pollinationNumber": {
142144
"description": "The unique identifier for this pollination event",
@@ -161,7 +163,7 @@
161163
]
162164
},
163165
"cross": {
164-
"description": "Pollination events associated with a cross",
166+
"description": "The Cross associated with this Pollination Event",
165167
"$ref": "../BrAPI-Germplasm/Cross.json#/$defs/Cross",
166168
"relationshipType": "many-to-one",
167169
"referencedAttribute": "pollinationEvents"

Specification/BrAPI-Schema/BrAPI-Germplasm/Germplasm.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
]
134134
},
135135
"germplasmDbId": {
136-
"description": "The ID which uniquely identifies a germplasm within the given database server \n<br>MIAPPE V1.1 (DM-41) Biological material ID - Code used to identify the biological material in the data file. Should be unique within the Investigation. Can correspond to experimental plant ID, seed lot ID, etc. This material identification is different from a BiosampleID which corresponds to Observation Unit or Samples sections below.",
136+
"description": "The ID which uniquely identifies a germplasm within the given database server \n<br>MIAPPE V1.1 (DM-41) Biological material ID - Code used to identify the biological material in the data file. Should be unique within the Investigation. Can correspond to experimental plant ID, inventory lot ID, etc. This material identification is different from a BiosampleID which corresponds to Observation Unit or Samples sections below.",
137137
"type": "string"
138138
},
139139
"germplasmName": {
@@ -155,7 +155,7 @@
155155
]
156156
},
157157
"germplasmPUI": {
158-
"description": "The Permanent Unique Identifier which represents a germplasm\n\nMIAPPE V1.1 (DM-41) Biological material ID - Code used to identify the biological material in the data file. Should be unique within the Investigation. Can correspond to experimental plant ID, seed lot ID, etc This material identification is different from a BiosampleID which corresponds to Observation Unit or Samples sections below.\n\nMIAPPE V1.1 (DM-51) Material source DOI - Digital Object Identifier (DOI) of the material source\n\nMCPD (v2.1) (PUID) 0. Any persistent, unique identifier assigned to the accession so it can be unambiguously referenced at the global level and the information associated with it harvested through automated means. Report one PUID for each accession. The Secretariat of the International Treaty on Plant Genetic Resources for Food and Agriculture (PGRFA) is facilitating the assignment of a persistent unique identifier (PUID), in the form of a DOI, to PGRFA at the accession level. Genebanks not applying a true PUID to their accessions should use, and request recipients to use, the concatenation of INSTCODE, ACCENUMB, and GENUS as a globally unique identifier similar in most respects to the PUID whenever they exchange information on accessions with third parties.",
158+
"description": "The Permanent Unique Identifier which represents a germplasm\n\nMIAPPE V1.1 (DM-41) Biological material ID - Code used to identify the biological material in the data file. Should be unique within the Investigation. Can correspond to experimental plant ID, inventory lot ID, etc This material identification is different from a BiosampleID which corresponds to Observation Unit or Samples sections below.\n\nMIAPPE V1.1 (DM-51) Material source DOI - Digital Object Identifier (DOI) of the material source\n\nMCPD (v2.1) (PUID) 0. Any persistent, unique identifier assigned to the accession so it can be unambiguously referenced at the global level and the information associated with it harvested through automated means. Report one PUID for each accession. The Secretariat of the International Treaty on Plant Genetic Resources for Food and Agriculture (PGRFA) is facilitating the assignment of a persistent unique identifier (PUID), in the form of a DOI, to PGRFA at the accession level. Genebanks not applying a true PUID to their accessions should use, and request recipients to use, the concatenation of INSTCODE, ACCENUMB, and GENUS as a globally unique identifier similar in most respects to the PUID whenever they exchange information on accessions with third parties.",
159159
"type": "string"
160160
},
161161
"germplasmPreprocessing": {
@@ -245,7 +245,6 @@
245245
"synonyms": {
246246
"description": "List of alternative names or IDs used to reference this germplasm\n\nMCPD (v2.1) (OTHERNUMB) 24. Any other identifiers known to exist in other collections for this accession. Use the following format: INSTCODE:ACCENUMB;INSTCODE:identifier;INSTCODE and identifier are separated by a colon without space. Pairs of INSTCODE and identifier are separated by a semicolon without space. When the institute is not known, the identifier should be preceded by a colon.",
247247
"relationshipType": "one-to-many",
248-
"referencedAttribute": "germplasm",
249248
"items": {
250249
"$ref": "../BrAPI-Germplasm/Germplasm.json#/$defs/Synonym",
251250
"description": "Synonyms"
@@ -264,7 +263,6 @@
264263
"$ref": "../BrAPI-Germplasm/Germplasm.json#/$defs/TaxonId",
265264
"description": "TaxonIds"
266265
},
267-
"title": "TaxonIds",
268266
"type": [
269267
"null",
270268
"array"
@@ -391,6 +389,7 @@
391389
}
392390
},
393391
"Donor": {
392+
"description": "Information about the Germplasm from the donor, such as the donor institute and the accession number from the donor institute. ",
394393
"properties": {
395394
"donorAccessionNumber": {
396395
"description": "The accession number assigned by the donor\n\nMCPD (v2.1) (DONORNUMB) 23. Identifier assigned to an accession by the donor. Follows ACCENUMB standard.",
@@ -407,7 +406,7 @@
407406
]
408407
},
409408
"germplasm": {
410-
"description": "donoers associated with a germplasm",
409+
"description": "donors associated with a germplasm",
411410
"$ref": "../BrAPI-Germplasm/Germplasm.json#/$defs/Germplasm",
412411
"relationshipType": "many-to-one",
413412
"referencedAttribute": "donors"
@@ -456,6 +455,7 @@
456455
}
457456
},
458457
"StorageType": {
458+
"description": "The type of storage for a Germplasm in a genebank",
459459
"properties": {
460460
"code": {
461461
"description": "The 2 digit code representing the type of storage this germplasm is kept in at a genebank. \n\nMCPD (v2.1) (STORAGE) 26. If germplasm is maintained under different types of storage, multiple choices are allowed, separated by a semicolon (e.g. 20;30). (Refer to FAO/IPGRI Genebank Standards 1994 for details on storage type.) \n\n10) Seed collection \n11) Short term \n12) Medium term \n13) Long term \n20) Field collection \n30) In vitro collection \n40) Cryo-preserved collection \n50) DNA collection \n99) Other (elaborate in REMARKS field)",
@@ -498,6 +498,7 @@
498498
}
499499
},
500500
"Synonym": {
501+
"description": "Alternative way to refer to a Germplasm, Cultivar of Variety",
501502
"properties": {
502503
"synonym": {
503504
"description": "Alternative name or ID used to reference this germplasm",
@@ -527,6 +528,7 @@
527528
}
528529
},
529530
"TaxonId": {
531+
"description": "The Taxon of the Germplasm",
530532
"properties": {
531533
"taxonId": {
532534
"description": "The identifier (name, ID, URI) of a particular taxonomy within the source provider",

0 commit comments

Comments
 (0)