You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Specification/BrAPI-Core/Lists/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -821,9 +821,9 @@ Review the <a target="_blank" href="https://wiki.brapi.org/index.php/Search_Serv
821
821
<tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr>
822
822
<tr><td><spanstyle="font-weight:bold;">commonCropNames</span></td><td>array[string]</td><td>The BrAPI Common Crop Name is the simple, generalized, widely accepted name of the organism being researched. It is most often used in multi-crop systems where digital resources need to be divided at a high level. Things like 'Maize', 'Wheat', and 'Rice' are examples of common crop names. Use this parameter to only return results associated with the given crops. Use `GET /commoncropnames` to find the list of available crops on a server.</td></tr>
823
823
<tr><td><spanstyle="font-weight:bold;">dateCreatedRangeEnd</span></td><td>string<br>(date-time)</td><td>Define the end for an interval of time and only include Lists that are created within this interval.</td></tr>
824
-
<tr><td><spanstyle="font-weight:bold;">dateCreatedRangeStart</span></td><td>string<br>(date-time)</td><td>Define the begining for an interval of time and only include Lists that are created within this interval.</td></tr>
824
+
<tr><td><spanstyle="font-weight:bold;">dateCreatedRangeStart</span></td><td>string<br>(date-time)</td><td>Define the beginning for an interval of time and only include Lists that are created within this interval.</td></tr>
825
825
<tr><td><spanstyle="font-weight:bold;">dateModifiedRangeEnd</span></td><td>string<br>(date-time)</td><td>Define the end for an interval of time and only include Lists that are modified within this interval.</td></tr>
826
-
<tr><td><spanstyle="font-weight:bold;">dateModifiedRangeStart</span></td><td>string<br>(date-time)</td><td>Define the begining for an interval of time and only include Lists that are modified within this interval.</td></tr>
826
+
<tr><td><spanstyle="font-weight:bold;">dateModifiedRangeStart</span></td><td>string<br>(date-time)</td><td>Define the beginning for an interval of time and only include Lists that are modified within this interval.</td></tr>
827
827
<tr><td><spanstyle="font-weight:bold;">externalReferenceIDs</span></td><td>array[string]</td><td>**Deprecated in v2.1** Please use `externalReferenceIds`. Github issue number #460 <br>List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)</td></tr>
828
828
<tr><td><spanstyle="font-weight:bold;">externalReferenceIds</span></td><td>array[string]</td><td>List of external reference IDs. Could be a simple strings or a URIs. (use with `externalReferenceSources` parameter)</td></tr>
829
829
<tr><td><spanstyle="font-weight:bold;">externalReferenceSources</span></td><td>array[string]</td><td>List of identifiers for the source system or database of an external reference (use with `externalReferenceIDs` parameter)</td></tr>
Copy file name to clipboardExpand all lines: Specification/BrAPI-Genotyping/AlleleMatrix/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ without having to download the entire genotype file.
49
49
+ preview (Optional, ) ... Default Value = false<br/>If 'preview' is set to true, then the server should return with the "dataMatrices" field as null or empty. All other data fields should be returned normally. This is intended to be a preview and give the client a sense of how large the matrix returned will be<br/>If 'preview' is set to false or not set (default), then the server should return all the matrix data as requested.
50
50
+ dataMatrixNames (Optional, ) ... "dataMatrixNames" is a comma seperated list of names (ie 'Genotype, Read Depth' etc). This list controls which data matrices are returned in the response.<br> This maps to a FORMAT field in the VCF file standard.
51
51
+ dataMatrixAbbreviations (Optional, ) ... "dataMatrixAbbreviations" is a comma seperated list of abbreviations (ie 'GT, RD' etc). This list controls which data matrices are returned in the response.<br> This maps to a FORMAT field in the VCF file standard.
52
-
+ positionRange (Optional, ) ... The postion range to search<br/> Uses the format "contig:start-end" where "contig" is the chromosome or contig name, "start" is the starting position of the range, and "end" is the ending position of the range<br> Example: CRHOM_1:12000-14000
52
+
+ positionRange (Optional, ) ... The position range to search<br/> Uses the format "contig:start-end" where "contig" is the chromosome or contig name, "start" is the starting position of the range, and "end" is the ending position of the range<br> Example: CRHOM_1:12000-14000
53
53
+ germplasmDbId (Optional, ) ... Use this parameter to only return results associated with the given `Germplasm` unique identifier. <br/>Use `GET /germplasm` to find the list of available `Germplasm` on a server.
54
54
+ germplasmName (Optional, ) ... Use this parameter to only return results associated with the given `Germplasm` by its human readable name. <br/>Use `GET /germplasm` to find the list of available `Germplasm` on a server.
55
55
+ germplasmPUI (Optional, ) ... Use this parameter to only return results associated with the given `Germplasm` by its global permanent unique identifier. <br/>Use `GET /germplasm` to find the list of available `Germplasm` on a server.
Copy file name to clipboardExpand all lines: Specification/BrAPI-Genotyping/GenomeMaps/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,12 @@ Get list of maps
24
24
<tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr>
25
25
<tr><td><spanstyle="font-weight:bold;">commonCropName</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The common name of the `Crop`</td></tr>
26
26
<tr><td><spanstyle="font-weight:bold;">mapDbId</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The ID which uniquely identifies a `GenomeMap`</td></tr>
27
+
<tr><td><spanstyle="font-weight:bold;">mapName</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>A human readable name for a `GenomeMap`</td></tr>
27
28
<tr><td><spanstyle="font-weight:bold;">type</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The type of map this represents, usually "Genetic" or "Physical"</td></tr>
28
29
<tr><td><spanstyle="font-weight:bold;">additionalInfo</span></td><td>object</td><td>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.</td></tr>
29
30
<tr><td><spanstyle="font-weight:bold;">comments</span></td><td>string</td><td>Additional comments about a `GenomeMap`</td></tr>
30
31
<tr><td><spanstyle="font-weight:bold;">documentationURL</span></td><td>string<br>(uri)</td><td>A URL to the human readable documentation of an object</td></tr>
31
32
<tr><td><spanstyle="font-weight:bold;">linkageGroupCount</span></td><td>integer</td><td>The number of linkage groups present in a `GenomeMap`</td></tr>
32
-
<tr><td><spanstyle="font-weight:bold;">mapName</span></td><td>string</td><td>A human readable name for a `GenomeMap`</td></tr>
33
33
<tr><td><spanstyle="font-weight:bold;">mapPUI</span></td><td>string</td><td>The DOI or other permanent identifier for a `GenomeMap`</td></tr>
34
34
<tr><td><spanstyle="font-weight:bold;">markerCount</span></td><td>integer</td><td>The number of markers present in a `GenomeMap`</td></tr>
35
35
<tr><td><spanstyle="font-weight:bold;">publishedDate</span></td><td>string<br>(date-time)</td><td>The date this `GenomeMap` was published</td></tr>
@@ -129,12 +129,12 @@ Provides the number of markers on each linkageGroup and the max position on the
129
129
<tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr>
130
130
<tr><td><spanstyle="font-weight:bold;">commonCropName</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The common name of the `Crop`</td></tr>
131
131
<tr><td><spanstyle="font-weight:bold;">mapDbId</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The ID which uniquely identifies a `GenomeMap`</td></tr>
132
+
<tr><td><spanstyle="font-weight:bold;">mapName</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>A human readable name for a `GenomeMap`</td></tr>
132
133
<tr><td><spanstyle="font-weight:bold;">type</span></td><td>string<br><spanstyle="font-size: smaller; color: red;">(Required)</span></td><td>The type of map this represents, usually "Genetic" or "Physical"</td></tr>
133
134
<tr><td><spanstyle="font-weight:bold;">additionalInfo</span></td><td>object</td><td>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.</td></tr>
134
135
<tr><td><spanstyle="font-weight:bold;">comments</span></td><td>string</td><td>Additional comments about a `GenomeMap`</td></tr>
135
136
<tr><td><spanstyle="font-weight:bold;">documentationURL</span></td><td>string<br>(uri)</td><td>A URL to the human readable documentation of an object</td></tr>
136
137
<tr><td><spanstyle="font-weight:bold;">linkageGroupCount</span></td><td>integer</td><td>The number of linkage groups present in a `GenomeMap`</td></tr>
137
-
<tr><td><spanstyle="font-weight:bold;">mapName</span></td><td>string</td><td>A human readable name for a `GenomeMap`</td></tr>
138
138
<tr><td><spanstyle="font-weight:bold;">mapPUI</span></td><td>string</td><td>The DOI or other permanent identifier for a `GenomeMap`</td></tr>
139
139
<tr><td><spanstyle="font-weight:bold;">markerCount</span></td><td>integer</td><td>The number of markers present in a `GenomeMap`</td></tr>
140
140
<tr><td><spanstyle="font-weight:bold;">publishedDate</span></td><td>string<br>(date-time)</td><td>The date this `GenomeMap` was published</td></tr>
0 commit comments