Skip to content

Commit f504a4a

Browse files
author
Guy Davenport
committed
revert description changes
1 parent c54076e commit f504a4a

6 files changed

Lines changed: 7 additions & 12 deletions

File tree

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@
4343
"controlledVocabularyProperties": [
4444
"attributeCategory"
4545
]
46-
},
47-
"description": "An Attribute is a Variable that is associated with certain entities which may have a\nAttribute Value for instances of that entity and\nis not an ObservationVariable that was record during the execution of a Study.\n\nAttributes are available for the following entities:\n* Cultivar see Cultivar Attribute\n* Locale see LocaleAttribute\n* Germplasm see GermplasmAttribute\n* Observation Unit see ObservationUnitAttribute\n* Inventory Lot see InventoryLotAttribute\n\n### Phenome Implementation\n\nIn phenome attributes are variables associated with a specific entity.\n\n### PRISM Implementation\n\nIn PRISM attributes are columns associated with a specific entity."
46+
}
4847
}
4948
},
5049
"$id": "https://brapi.org/Specification/BrAPI-Schema/BrAPI-Phenotyping/Attribute.json",

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717
]
1818
}
1919
},
20-
"type": "object",
21-
"description": "External References are used to link entities to equivalent entities. The External Reference has two fields:\n\n* **referenceId** - The external reference ID. Could be a simple string or a URI.\n* **referenceSource**\t- An identifier for the source system or database of this reference.\n\nThere are two main uses of External References.\n\n* An array of External References are provided in the result of many queries, which allows equivalent entities\n to be found in other systems using these identifiers.\n* External References can be provided as arguments in many queries, which allows querying by\n\nThe value of the **referenceSource** field provides the context of the **referenceId** field. \n\nThe table below shows the currently available `referenceSources` for different entities, a description of the `referenceId`, and an example:\n\n| Reference Source | Entities | Description | Example |\n|---------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|\n| CROP_2_LETTER_CODE | Crop | The 2 letter code for the crop defined in the Crop Ontology | WH |\n| CROP_3_LETTER_CODE | Crop | The 3 letter code for the crop defined in the Crop Ontology | TRI |\n| CROP_ONTOLOGY_ID | Crop | The ID of the crop in the Crop Ontology | a9d1511d-a50b-3838-a3fe-58219510e6f4 |\n| PRISM_CROP_CODE | Crop | The crop code for the crop defined in PRISM | WH |\n| PRISM_CROP_ID | Crop | The business code for a crop in PRISM. It is in the format ^PCRP(?=FCR VEG)[0-9]{4}[1-9]? | PCRPFCR1004 | \n| PRISM_MATERIAL_ID | Germplasm/Cultivar | The ID used for Material, which can be used to uniquely identify Cultivars or to identify Germplasm belong to a PRISM material. | PMWH20743430 |\n| PRISM_MATERIAL_NAME | Germplasm/Cultivar | The Name used for Material, which might be the Cultivar name or the name of PRISM material associated with a Germplasm | G16Q2x0749.WTHCMSt |\n| PRISM_NFB_ID | Study/Locale | The ID of the Nursery Field Book in PRISM. Provided when the Study or Locale originates from a PRISM Nursery Field Book | PDCEFCR565640 | \n| PRISM_NFB_NAME | Study/Locale | The name of the Nursery Field Book in PRISM. Provided when the Study or Locale originates from a PRISM Nursery Field Book | | \n| PRISM_YTFB_ID | Study/Locale | The ID of the Yield Trial Field Book in PRISM. Provided when the Study or Locale originates from a Yield Trial Field Book | PDCEFCR565569 |\n| PRISM_YTFB_NAME | Study/Locale | The name of the Yield Trial Field Book in PRISM. Provided when the Study or Locale originates from a Yield Trial Field Book | |\n| TRAM_CODE | Observation Variable | The code of the equivalent variable in TRAM | TTOC:0005045 | \n\n### Implementation\n\nExternal References are implemented consistently across data providers (PRISM and Phenome),\nbut a Data Provider may not provide all possible External References for a specific Entity."
20+
"type": "object"
2221
}
2322
},
2423
"$id": "https://brapi.org/Specification/BrAPI-Schema/Components/Common/ExternalReference.json",

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@
5959
],
6060
"type": "object"
6161
}
62-
],
63-
"description": "GeoJSONGeometry can either be a GeoJSONPoint \nor a GeoJSONPolygon.\n\nIt is used by geometry in GeoJSON\n\n### Implementation\n\nSee the fields in which GeoJSON is used."
62+
]
6463
}
6564
},
6665
"$id": "https://brapi.org/Specification/BrAPI-Schema/Components/Common/AdditionalInfo.json",

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,9 @@
6262
],
6363
"brapi-metadata": {
6464
"primaryModel": true
65-
},
66-
"description": "An **Observation Variable** is a parameter of the observation unit that is assessed in the context of a study. An ObservationVariable is defined at **crop**-level.\n\nSeveral Observation Variables can be related to the same phenotypic characteristic\n(e.g. height) but will be considered as different observation variables\nif they are measured at a different scale.\nFor example, the Observation Variable 'height in centimeters' differs from the \nObservation Variable 'height in inches'.\n\nAn Observation Variable is typically used to capture phenotypic measurements such as \nheight, yield, weight, etc. However, it can also capture genotypic or other characteristics. \n\n### Phenome Implementation\n\nObservation Variables are Variables with the Variable type 'Variate'\nthat have been assigned to the Germplasm entity.\n\n### PRISM Implementation\n\n> TODO Breeding Services please check\n\nIn Field Crops and Vegetable Observation Variables are held different workbooks depending\non the type of Study and are columns in the corresponding field book table."
65+
}
6766
}
6867
},
6968
"$id": "https://brapi.org/Specification/BrAPI-Schema/BrAPI-Phenotyping/ObservationVariable.json",
7069
"$schema": "http://json-schema.org/draft/2020-12/schema"
71-
}
70+
}

Specification/BrAPI-Schema/Requests/ProgramRequest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"description": "The type of program entity this object represents\n<br/> 'STANDARD' represents a standard, permanent breeding program\n<br/> 'PROJECT' represents a short term project, usually with a set time limit based on funding ",
6060
"items": {
6161
"type": "string",
62-
"description": "The type of program entity this object represents\n<br/> 'STANDARD' represents a standard, permanent breeding program\n<br/> 'PROJECT' represents a short term project, usually with a set time limit based on funding ",
62+
"description": "The type of program entity this object represents\n<br/> 'STANDARD' represents a standard, permanent breeding program\n<br/> 'PROJECT' represents a short term project, usually with a set time limit based on funding.",
6363
"enum": [
6464
"STANDARD",
6565
"PROJECT"

Specification/BrAPI-Schema/Requests/Schemas/GeoJSONSearchArea.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@
4040
],
4141
"brapi-metadata": {
4242
"request": true
43-
},
44-
"description": "The GeoJSONSearchArea provides a way to search by position.\nIt is used in coordinates in LocationRequest\nand imageLocation in ImageRequest\n\n### Implementation\n\nGeoJSONSearchArea is not currently implemented in BrAPI+."
43+
}
4544
}
4645
},
4746
"$id": "https://brapi.org/Specification/BrAPI-Schema/Requests/Schemas/GeoJSONSearchArea.json",

0 commit comments

Comments
 (0)