Skip to content

Commit 2db9a19

Browse files
author
Guy Davenport
committed
used co-pliot to copy examples from yaml files to json schema
1 parent 3b2df27 commit 2db9a19

25 files changed

+349
-172
lines changed

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

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"type": [
1313
"null",
1414
"string"
15-
]
15+
],
16+
"example": "Maize"
1617
},
1718
"contextOfUse": {
1819
"description": "Indication of how trait is routinely used. (examples: [\"Trial evaluation\", \"Nursery evaluation\"])",
@@ -22,22 +23,25 @@
2223
"type": [
2324
"null",
2425
"array"
25-
]
26+
],
27+
"example": ["Trial evaluation", "Nursery evaluation"]
2628
},
2729
"defaultValue": {
2830
"description": "Variable default value. (examples: \"red\", \"2.3\", etc.)",
2931
"type": [
3032
"null",
3133
"string"
32-
]
34+
],
35+
"example": "2.0"
3336
},
3437
"documentationURL": {
3538
"description": "A URL to the human readable documentation of an object",
3639
"format": "uri",
3740
"type": [
3841
"null",
3942
"string"
40-
]
43+
],
44+
"example": "https://wiki.brapi.org/documentation.html"
4145
},
4246
"externalReferences": {
4347
"description": "An array of external reference ids. These are references to this piece of data in an external system. Could be a simple string or a URI.",
@@ -57,21 +61,24 @@
5761
"type": [
5862
"null",
5963
"string"
60-
]
64+
],
65+
"example": "flowering"
6166
},
6267
"institution": {
6368
"description": "Name of institution submitting the variable",
6469
"type": [
6570
"null",
6671
"string"
67-
]
72+
],
73+
"example": "The BrAPI Institute"
6874
},
6975
"language": {
7076
"description": "2 letter ISO 639-1 code for the language of submission of the variable.",
7177
"type": [
7278
"null",
7379
"string"
74-
]
80+
],
81+
"example": "en"
7582
},
7683
"method": {
7784
"description": "A description of the way an Observation should be collected. \n<br>For example, an ObservationVariable might be defined with a Trait of \"plant height\", a Scale of \"meters\", and a Method of \"tape measure\". This variable would be distinct from a variable with the Method \"estimation\" or \"drone image processing\". ",
@@ -93,14 +100,16 @@
93100
"type": [
94101
"null",
95102
"string"
96-
]
103+
],
104+
"example": "Dr. Bob Robertson"
97105
},
98106
"status": {
99107
"description": "Variable status. (examples: \"recommended\", \"obsolete\", \"legacy\", etc.)",
100108
"type": [
101109
"null",
102110
"string"
103-
]
111+
],
112+
"example": "recommended"
104113
},
105114
"submissionTimestamp": {
106115
"description": "Timestamp when the Variable was added (ISO 8601)",
@@ -118,7 +127,8 @@
118127
"type": [
119128
"null",
120129
"array"
121-
]
130+
],
131+
"example": ["Maize Height", "Stalk Height", "Corn Height"]
122132
},
123133
"trait": {
124134
"description": "A Trait describes what property is being observed. \n<br>For example, an ObservationVariable might be defined with a Trait of \"plant height\", a Scale of \"meters\", and a Method of \"tape measure\". This variable would be distinct from a variable with the Trait \"Leaf length\" or \"Flower height\". ",

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
"type": [
1717
"null",
1818
"array"
19-
]
19+
],
20+
"example": ["758a78c0", "2c78f9ee"]
2021
},
2122
"dateCreated": {
2223
"description": "Timestamp when the entity was first created",
@@ -56,18 +57,21 @@
5657
"type": [
5758
"null",
5859
"string"
59-
]
60+
],
61+
"example": "This is a list of germplasm I would like to investigate next season"
6062
},
6163
"listName": {
6264
"description": "Human readable name of a List",
63-
"type": "string"
65+
"type": "string",
66+
"example": "MyGermplasm_Sept_2020"
6467
},
6568
"listOwnerName": {
6669
"description": "Human readable name of a List Owner. (usually a user or person)",
6770
"type": [
6871
"null",
6972
"string"
70-
]
73+
],
74+
"example": "Bob Robertson"
7175
},
7276
"listOwnerPerson": {
7377
"$ref": "Person.json#/$defs/Person",
@@ -80,14 +84,16 @@
8084
"type": [
8185
"null",
8286
"integer"
83-
]
87+
],
88+
"example": 53
8489
},
8590
"listSource": {
8691
"description": "The description of where a List originated from",
8792
"type": [
8893
"null",
8994
"string"
90-
]
95+
],
96+
"example": "GeneBank Repository 1.3"
9197
},
9298
"listType": {
9399
"description": "A flag to indicate the type of objects that are referenced in a List",

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

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"type": [
88
"null",
99
"string"
10-
]
10+
],
11+
"example": "L1"
1112
},
1213
"additionalInfo": {
1314
"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.",
@@ -19,14 +20,16 @@
1920
"type": [
2021
"null",
2122
"string"
22-
]
23+
],
24+
"example": "North East corner of greenhouse"
2325
},
2426
"coordinateUncertainty": {
2527
"description": "Uncertainty associated with the coordinates in meters. Leave the value empty if the uncertainty is unknown.",
2628
"type": [
2729
"null",
2830
"string"
29-
]
31+
],
32+
"example": "20"
3033
},
3134
"coordinates": {
3235
"description": "One geometry as defined by GeoJSON (RFC 7946). All coordinates are decimal values on the WGS84 geographic coordinate reference system.\n\nCopied from RFC 7946 Section 3.1.1\n\nA position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, or\neasting and northing, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.",
@@ -38,36 +41,41 @@
3841
"type": [
3942
"null",
4043
"string"
41-
]
44+
],
45+
"example": "PER"
4246
},
4347
"countryName": {
4448
"description": "The full name of the country where a Location is located\n<br/> MIAPPE V1.1 (DM-17) Geographic location (country) - The country where the experiment took place, either as a full name or preferably as a 2-letter code.",
4549
"type": [
4650
"null",
4751
"string"
48-
]
52+
],
53+
"example": "Peru"
4954
},
5055
"documentationURL": {
5156
"description": "A URL to the human readable documentation of an object",
5257
"format": "uri",
5358
"type": [
5459
"null",
5560
"string"
56-
]
61+
],
62+
"example": "https://brapi.org"
5763
},
5864
"environmentType": {
5965
"description": "Describes the general type of environment of a Location. (ex. forest, field, nursery, etc)",
6066
"type": [
6167
"null",
6268
"string"
63-
]
69+
],
70+
"example": "Nursery"
6471
},
6572
"exposure": {
6673
"description": "Describes the level of protection/exposure for things like sun light and wind at a particular Location",
6774
"type": [
6875
"null",
6976
"string"
70-
]
77+
],
78+
"example": "Structure, no exposure"
7179
},
7280
"externalReferences": {
7381
"description": "An array of external reference ids. These are references to this piece of data in an external system. Could be a simple string or a URI.",
@@ -87,29 +95,33 @@
8795
"type": [
8896
"null",
8997
"string"
90-
]
98+
],
99+
"example": "71 Pilgrim Avenue Chevy Chase MD 20815"
91100
},
92101
"instituteName": {
93102
"description": "The full name of the institute at a particular Location\n<br/> MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.",
94103
"type": [
95104
"null",
96105
"string"
97-
]
106+
],
107+
"example": "Plant Science Institute"
98108
},
99109
"locationDbId": {
100110
"description": "The unique identifier for a Location",
101111
"type": "string"
102112
},
103113
"locationName": {
104114
"description": "A human readable name for a Location\n<br/> MIAPPE V1.1 (DM-18) Experimental site name - The name of the natural site, experimental field, greenhouse, phenotyping facility, etc. where the experiment took place.",
105-
"type": "string"
115+
"type": "string",
116+
"example": "Location 1"
106117
},
107118
"locationType": {
108119
"description": "A short description of a type of Location (ex. Field Station, Breeding Location, Storage Location, etc)",
109120
"type": [
110121
"null",
111122
"string"
112-
]
123+
],
124+
"example": "Field Station"
113125
},
114126
"parentLocation": {
115127
"$ref": "Location.json#/$defs/Location",
@@ -150,21 +162,24 @@
150162
"type": [
151163
"null",
152164
"string"
153-
]
165+
],
166+
"example": "Private"
154167
},
155168
"slope": {
156169
"description": "Describes the approximate slope (height/distance) of a Location.",
157170
"type": [
158171
"null",
159172
"string"
160-
]
173+
],
174+
"example": "0"
161175
},
162176
"topography": {
163177
"description": "Describes the topography of the land at a Location. (ex. Plateau, Cirque, Hill, Valley, etc)",
164178
"type": [
165179
"null",
166180
"string"
167-
]
181+
],
182+
"example": "Valley"
168183
},
169184
"seedLots": {
170185
"title": "SeedLots",

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@
1212
"type": [
1313
"null",
1414
"string"
15-
]
15+
],
16+
"example": "Bob likes pina coladas and getting caught in the rain."
1617
},
1718
"emailAddress": {
1819
"description": "email address for this person",
1920
"type": [
2021
"null",
2122
"string"
22-
]
23+
],
24+
"example": "[email protected]"
2325
},
2426
"externalReferences": {
2527
"description": "An array of external reference ids. These are references to this piece of data in an external system. Could be a simple string or a URI.",
@@ -39,28 +41,32 @@
3941
"type": [
4042
"null",
4143
"string"
42-
]
44+
],
45+
"example": "Bob"
4346
},
4447
"lastName": {
4548
"description": "Persons last name",
4649
"type": [
4750
"null",
4851
"string"
49-
]
52+
],
53+
"example": "Robertson"
5054
},
5155
"mailingAddress": {
5256
"description": "physical address of this person",
5357
"type": [
5458
"null",
5559
"string"
56-
]
60+
],
61+
"example": "123 Street Ave, City, State, Country"
5762
},
5863
"middleName": {
5964
"description": "Persons middle name",
6065
"type": [
6166
"null",
6267
"string"
63-
]
68+
],
69+
"example": "Danger"
6470
},
6571
"personDbId": {
6672
"description": "Unique ID for a person",
@@ -71,14 +77,16 @@
7177
"type": [
7278
"null",
7379
"string"
74-
]
80+
],
81+
"example": "+1-555-555-5555"
7582
},
7683
"userID": {
7784
"description": "A systems user ID associated with this person. Different from personDbId because you could have a person who is not a user of the system.",
7885
"type": [
7986
"null",
8087
"string"
81-
]
88+
],
89+
"example": "bob-23"
8290
},
8391
"lists": {
8492
"title": "Lists",

0 commit comments

Comments
 (0)