Skip to content

Commit 9a99fbb

Browse files
guydavenportGuy DavenportBrapiCoordinatorSelby
authored
copied descriptions from V2.2 (#652)
* copied descriptions from V2.2 * Apply automatic changes --------- Co-authored-by: Guy Davenport <guy.davenport@partners.basf.com> Co-authored-by: guydavenport <6523224+guydavenport@users.noreply.github.com> Co-authored-by: Peter Selby <ps664@cornell.edu>
1 parent 13838bb commit 9a99fbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+13656
-351
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
}
3131
},
3232
"title": "OntologyTerm",
33+
"description": "A pointer to an ontology used by a genomic reference",
3334
"type": "object",
3435
"brapi-metadata": {
3536
"primaryModel": false

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@
132132
"scale"
133133
],
134134
"title": "Variable",
135+
"description": "A unique combination of Trait, Method, and Scale to define a clear context for an Observation.",
135136
"type": "object",
136137
"brapi-metadata": {
137138
"interface": true

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
],
4848
"type": "object",
4949
"title": "Contact",
50+
"description": "A persons contact information",
5051
"brapi-metadata": {
5152
"primaryModel": false
5253
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
}
6262
},
6363
"title": "DataLink",
64+
"description": "A link to extra data files associated with this study. Extra data could include notes, images, and reference data.",
6465
"type": "object",
6566
"brapi-metadata": {
6667
"primaryModel": false

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
],
102102
"title": "List",
103103
"type": "object",
104+
"description": "A List represents a collection of other BrAPI data objects. Typically these are custom lists generated by a user to keep track of interesting data. For example, a user might build a List of Germplasm that they have manually marked for further study.",
104105
"brapi-metadata": {
105106
"primaryModel": true
106107
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@
200200
"locationName"
201201
],
202202
"title": "Location",
203+
"description": "A geographic Location on earth. This is usually used to describe the general area where an experiment took place. For example, a natural site, an experimental field, a greenhouse, a phenotyping facility, etc.",
203204
"type": "object",
204205
"brapi-metadata": {
205206
"primaryModel": true

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@
113113
"personDbId"
114114
],
115115
"title": "Person",
116+
"description": "A generic object used to maintain the metadata needed to describe a human. The Person might be a software user, a field technician, or a primary contact for a Program.",
116117
"type": "object",
117118
"brapi-metadata": {
118119
"primaryModel": true

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@
172172
"programName"
173173
],
174174
"title": "Program",
175+
"description": "A BrAPI Program represents the high level organization or group who is responsible for conducting trials and studies. Things like Breeding Programs and Funded Projects are considered BrAPI Programs. A Program can contain multiple Trials. A Trial can contain multiple Studies.",
175176
"type": "object",
176177
"brapi-metadata": {
177178
"primaryModel": true

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"seasonDbId"
2626
],
2727
"title": "Season",
28+
"description": "A Season defines a period in time. A Season is made of two parts; (1) the primary year and (2) a term which defines a segment of the year. This term could be a traditional season, like \"Spring\" or \"Summer\", or this term could be a month, like \"May\" or \"June\", or this could be an arbitrary season name which is meaningful to the breeding Program like \"PlantingTime_3\" or \"Season E\".",
2829
"type": "object",
2930
"brapi-metadata": {
3031
"primaryModel": true

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,7 @@
316316
"studyDbId"
317317
],
318318
"title": "Study",
319+
"description": "A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.",
319320
"type": "object",
320321
"brapi-metadata": {
321322
"primaryModel": true
@@ -383,6 +384,7 @@
383384
"description"
384385
],
385386
"title": "EnvironmentParameters",
387+
"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).",
386388
"type": "object",
387389
"brapi-metadata": {
388390
"primaryModel": false
@@ -412,6 +414,7 @@
412414
}
413415
},
414416
"title": "ExperimentalDesign",
417+
"description": "The experimental and statistical design full description plus a category PUI taken from crop research ontology or agronomy ontology",
415418
"type": "object",
416419
"brapi-metadata": {
417420
"primaryModel": false
@@ -441,6 +444,7 @@
441444
}
442445
},
443446
"title": "GrowthFacility",
447+
"description": "Short description of the facility in which the study was carried out.",
444448
"type": "object",
445449
"brapi-metadata": {
446450
"primaryModel": false
@@ -476,6 +480,7 @@
476480
"lastUpdateDbId"
477481
],
478482
"title": "LastUpdate",
483+
"description": "The date and time when this study was last modified",
479484
"type": "object",
480485
"brapi-metadata": {
481486
"primaryModel": false

0 commit comments

Comments
 (0)