Skip to content

Commit e4a0b7a

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

File tree

12 files changed

+32
-18
lines changed

12 files changed

+32
-18
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@
108108
},
109109
"locationDbId": {
110110
"description": "The unique identifier for a Location",
111-
"type": "string"
111+
"type": "string",
112+
"example": "3cfdd67d"
112113
},
113114
"locationName": {
114115
"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.",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@
7070
},
7171
"personDbId": {
7272
"description": "Unique ID for a person",
73-
"type": "string"
73+
"type": "string",
74+
"example": "14340a54"
7475
},
7576
"phoneNumber": {
7677
"description": "phone number of this person",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@
6969
},
7070
"programDbId": {
7171
"description": "The ID which uniquely identifies the program",
72-
"type": "string"
72+
"type": "string",
73+
"example": "f60f15b2"
7374
},
7475
"programName": {
7576
"description": "Human readable name of the program",

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
},
6060
"endDate": {
6161
"description": "The date this trial ends",
62+
"format": "date",
6263
"type": [
6364
"null",
6465
"string"
@@ -113,14 +114,16 @@
113114
},
114115
"startDate": {
115116
"description": "The date this trial started",
117+
"format": "date",
116118
"type": [
117119
"null",
118120
"string"
119121
]
120122
},
121123
"trialDbId": {
122124
"description": "The ID which uniquely identifies a trial\n\nMIAPPE V1.1 (DM-2) Investigation unique ID - Identifier comprising the unique name of the institution/database hosting the submission of the investigation data, and the accession number of the investigation in that institution.",
123-
"type": "string"
125+
"type": "string",
126+
"example": "1883b402"
124127
},
125128
"trialDescription": {
126129
"description": "The human readable description of a trial\n\nMIAPPE V1.1 (DM-4) Investigation description - Human-readable text describing the investigation in more detail.",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
},
3131
"plateDbId": {
3232
"description": "The ID which uniquely identifies a `Plate`",
33-
"type": "string"
33+
"type": "string",
34+
"example": "a106467f"
3435
},
3536
"plateFormat": {
3637
"description": "Enum for plate formats, usually \"PLATE_96\" for a 96 well plate or \"TUBES\" for plateless format",

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,17 +94,16 @@
9494
},
9595
"sampleDbId": {
9696
"description": "The ID which uniquely identifies a `Sample`\n<br> MIAPPE V1.1 (DM-76) Sample ID - Unique identifier for the sample.",
97-
"type": [
98-
"null",
99-
"string"
100-
]
97+
"type": "string",
98+
"example": "cd06a61d"
10199
},
102100
"sampleGroupId": {
103101
"description": "The ID which uniquely identifies a group of `Samples`",
104102
"type": [
105103
"null",
106104
"string"
107-
]
105+
],
106+
"example": "8524b436"
108107
},
109108
"sampleName": {
110109
"description": "The human readable name of the `Sample`",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
},
2424
"crossDbId": {
2525
"description": "the unique identifier for a cross",
26-
"type": "string"
26+
"type": "string",
27+
"example": "d105fd6f"
2728
},
2829
"crossName": {
2930
"description": "the human readable name for a cross",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@
143143
},
144144
"germplasmDbId": {
145145
"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.",
146-
"type": "string"
146+
"type": "string",
147+
"example": "d4076594"
147148
},
148149
"germplasmName": {
149150
"description": "Name of the germplasm. It can be the preferred name and does not have to be unique.\n\nMCPD (v2.1) (ACCENAME) 11. Either a registered or other designation given to the material received, other than the donors accession number (23) or collecting number (3). First letter uppercase. Multiple names are separated by a semicolon without space.",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@
7272
},
7373
"seedLotDbId": {
7474
"description": "Unique DbId for the Seed Lot",
75-
"type": "string"
75+
"type": "string",
76+
"example": "261ecb09"
7677
},
7778
"seedLotDescription": {
7879
"description": "A general description of this Seed Lot",

Specification/BrAPI-Schema/BrAPI-Phenotyping/Observation.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"type": [
1313
"null",
1414
"string"
15-
]
15+
],
16+
"example": "917d3ae0"
1617
},
1718
"externalReferences": {
1819
"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.",
@@ -41,7 +42,8 @@
4142
},
4243
"observationDbId": {
4344
"description": "The ID which uniquely identifies an observation",
44-
"type": "string"
45+
"type": "string",
46+
"example": "ef24b615"
4547
},
4648
"observationTimeStamp": {
4749
"description": "The date and time when this observation was made",
@@ -79,7 +81,8 @@
7981
"type": [
8082
"null",
8183
"string"
82-
]
84+
],
85+
"example": "a2f7f60b"
8386
},
8487
"value": {
8588
"description": "The value of the data collected as an observation",

0 commit comments

Comments
 (0)