Apply automatic changes

Author: BrapiCoordinatorSelby

Specification/Generated/BrAPI-Core.yaml

@@ -1719,6 +1719,7 @@ components:
           type: string
         type:
           type: string
+      description: A persons contact information
     ContentTypes:
       type: string
       enum:
@@ -1757,6 +1758,8 @@ components:
           type: string
         version:
           type: string
+      description: "A link to extra data files associated with this study. Extra data\
+        \ could include notes, images, and reference data."
     DatasetAuthorships:
       type: object
       properties:
@@ -1774,6 +1777,7 @@ components:
           type: string
         trialPUI:
           type: string
+      description: License and citation information for the data in this trial
     EnvironmentParameters:
       required:
       - description
@@ -1803,6 +1807,12 @@ components:
           type: string
         valuePUI:
           type: string
+      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)."
     ExperimentalDesign:
       type: object
       properties:
@@ -1816,6 +1826,8 @@ components:
           type: string
         studyPUI:
           type: string
+      description: The experimental and statistical design full description plus a
+        category PUI taken from crop research ontology or agronomy ontology
     ExternalReference:
       type: object
       properties:
@@ -1905,6 +1917,8 @@ components:
           type: string
         studyPUI:
           type: string
+      description: Short description of the facility in which the study was carried
+        out.
     LastUpdate:
       required:
       - lastUpdateDbId
@@ -1922,6 +1936,7 @@ components:
           type: string
         version:
           type: string
+      description: The date and time when this study was last modified
     List:
       required:
       - listDbId
@@ -1950,6 +1965,10 @@ components:
           $ref: "#/components/schemas/ListType"
         personDbId:
           type: string
+      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."
     ListNewRequest:
       required:
       - listDbId
@@ -1981,6 +2000,10 @@ components:
           $ref: "#/components/schemas/ListType"
         personDbId:
           type: string
+      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."
     ListSearchRequest:
       type: object
       properties:
@@ -1994,6 +2017,10 @@ components:
           type: string
         listType:
           $ref: "#/components/schemas/ListType"
+      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."
     ListType:
       type: string
       description: The type of objects that are referenced in a List
@@ -2054,6 +2081,9 @@ components:
           type: string
         topography:
           type: string
+      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."
     LocationNewRequest:
       required:
       - locationDbId
@@ -2101,6 +2131,9 @@ components:
           type: string
         topography:
           type: string
+      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."
     LocationSearchRequest:
       type: object
       properties:
@@ -2110,6 +2143,9 @@ components:
           type: number
         coordinates:
           $ref: "#/components/schemas/GeoJSONSearchArea"
+      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."
     ObservationUnitHierarchyLevel:
       type: object
       properties:
@@ -2137,6 +2173,7 @@ components:
           type: string
         termURI:
           type: string
+      description: A pointer to an ontology used by a genomic reference
     Person:
       required:
       - personDbId
@@ -2160,6 +2197,9 @@ components:
           type: string
         userID:
           type: string
+      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."
     PersonNewRequest:
       required:
       - personDbId
@@ -2186,9 +2226,15 @@ components:
           type: string
         userID:
           type: string
+      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."
     PersonSearchRequest:
       type: object
       properties: {}
+      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."
     Program:
       required:
       - programDbId
@@ -2220,6 +2266,10 @@ components:
           enum:
           - STANDARD
           - PROJECT
+      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.
     ProgramNewRequest:
       required:
       - programDbId
@@ -2254,9 +2304,17 @@ components:
           enum:
           - STANDARD
           - PROJECT
+      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.
     ProgramSearchRequest:
       type: object
       properties: {}
+      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.
     Publication:
       type: object
       properties:
@@ -2270,6 +2328,9 @@ components:
           type: string
         trialPUI:
           type: string
+      description: MIAPPE V1.1 (DM-9) Associated publication - An identifier for a
+        literature publication where the investigation is described. Use of DOIs is
+        recommended.
     Season:
       required:
       - seasonDbId
@@ -2282,6 +2343,12 @@ components:
         year:
           type: integer
           format: int32
+      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\"."
     Study:
       required:
       - studyDbId
@@ -2348,6 +2415,10 @@ components:
           type: string
         trialPUI:
           type: string
+      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.
     StudyNewRequest:
       required:
       - studyDbId
@@ -2417,11 +2488,19 @@ components:
           type: string
         trialPUI:
           type: string
+      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.
     StudySearchRequest:
       type: object
       properties:
         active:
           type: boolean
+      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.
     TraitDataType:
       type: string
       description: |-
@@ -2477,6 +2556,10 @@ components:
           type: string
         trialPUI:
           type: string
+      description: "A Trial represents a collection of Study objects, and the metadata\
+        \ associated with that collection. A Trial could represent a multi-location\
+        \ experiment, and could contain information related to publications and data\
+        \ licensing."
     TrialNewRequest:
       required:
       - trialDbId
@@ -2516,6 +2599,10 @@ components:
           type: string
         trialPUI:
           type: string
+      description: "A Trial represents a collection of Study objects, and the metadata\
+        \ associated with that collection. A Trial could represent a multi-location\
+        \ experiment, and could contain information related to publications and data\
+        \ licensing."
     TrialSearchRequest:
       type: object
       properties:
@@ -2525,6 +2612,10 @@ components:
           type: string
         searchDateRangeStart:
           type: string
+      description: "A Trial represents a collection of Study objects, and the metadata\
+        \ associated with that collection. A Trial could represent a multi-location\
+        \ experiment, and could contain information related to publications and data\
+        \ licensing."
     Variable:
       required:
       - method
@@ -2568,6 +2659,8 @@ components:
             type: string
         trait:
           $ref: "#/components/schemas/Trait"
+      description: "A unique combination of Trait, Method, and Scale to define a clear\
+        \ context for an Observation."
     basePagination:
       required:
       - currentPage