added nullable: true to core

Author: Guy Davenport

Specification/BrAPI-Core/Locations/Schemas/LocationNewRequest.yaml

@@ -13,45 +13,53 @@ components:
         abbreviation:
           description: A shortened version of the human readable name for a Location
           type: string
+          nullable: true
           example: L1
         additionalInfo:
           additionalProperties:
             type: string
           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.
           type: object
+          nullable: true
           example: {}
         coordinateUncertainty:
           description: Uncertainty associated with the coordinates in meters. Leave the value empty if the uncertainty is unknown.
           type: string
+          nullable: true
           example: '20'
         countryCode:
           description: |-
             [ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec
             <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.'
           type: string
+          nullable: true
           example: PER
         countryName:
           description: |-
             The full name of the country where a Location is located
             <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.
           type: string
+          nullable: true
           example: Peru
         documentationURL:
           description: A URL to the human readable documentation of an object
           format: uri
           type: string
+          nullable: true
           example: https://brapi.org
         instituteAddress:
           description: |-
             The street address of the institute at a particular Location
             <br/> MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.
           type: string
+          nullable: true
           example: 71 Pilgrim Avenue Chevy Chase MD 20815
         instituteName:
           description: |-
             The full name of the institute at a particular Location
             <br/> MIAPPE V1.1 (DM-16) Contact institution - Name and address of the institution responsible for the study.
           type: string
+          nullable: true
           example: Plant Science Institute
         locationName:
           description: |-
@@ -65,45 +73,56 @@ components:
             <br/> The Parent Location defines the encompassing Location that a smaller Location belongs to. 
             For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.
           type: string
+          nullable: true
           example: 0a93f7d8
         parentLocationName:
           description: |-
             A human readable name for a location
             <br/> The Parent Location defines the encompassing Location that a smaller Location belongs to.  
             For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.
           type: string
+          nullable: true
           example: Field Station Alpha
         locationType:
           description: A short description of a type of Location (ex. Field Station, Breeding Location, Storage Location, etc)
           type: string
+          nullable: true
           example: Field Station
         siteStatus:
           description: Description of the accessibility of the location (ex. Public, Private)
           type: string
           example: Private
+          nullable: true
         coordinateDescription:
           description: Describes the precision and landmarks of the coordinate values used for a Location. (ex. the site, the nearest town, a 10 kilometers radius circle, +/- 20 meters, etc)
           type: string
+          nullable: true
           example: North East corner of greenhouse
         slope:
           description: Describes the approximate slope (height/distance) of a Location.
           type: string
+          nullable: true
           example: '0'
         exposure:
           description: Describes the level of protection/exposure for things like sun light and wind at a particular Location
           type: string
+          nullable: true
           example: Structure, no exposure
         environmentType:
           description: Describes the general type of environment of a Location. (ex. forest, field, nursery, etc)
           type: string
+          nullable: true
           example: Nursery
         topography:
           description: Describes the topography of the land at a Location. (ex. Plateau, Cirque, Hill, Valley, etc)
           type: string
+          nullable: true
           example: Valley
         coordinates:
           $ref: '#/components/schemas/geoJSON'
+          nullable: true
         externalReferences: 
           $ref: '#/components/schemas/ExternalReferences'
+          nullable: true
 
 

Specification/BrAPI-Core/Locations/Schemas/LocationSearchRequest.yaml

@@ -17,46 +17,55 @@ components:
           abbreviations:
             description: A list of shortened human readable names for a set of Locations
             type: array
+            nullable: true
             items:
               type: string
             example: ['L1', 'LHC']
           altitudeMin:
             description: The minimum altitude to search for
             type: number
+            nullable: true
             example: 20
           altitudeMax:
             description: The maximum altitude to search for
             type: number
+            nullable: true
             example: 200
           countryCodes:
             description: '[ISO_3166-1_alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) spec'
             type: array
+            nullable: true
             items:
               type: string
             example: ['USA', 'PER']
           countryNames:
             description: The full name of the country to search for
             type: array
+            nullable: true
             items:
               type: string
             example: ['United States of America', 'Peru']
           coordinates: 
             $ref: '#/components/schemas/geoJSONSearchArea'
+            nullable: true
           instituteAddresses:
             description: The street address of the institute to search for
             type: array
+            nullable: true
             items:
               type: string
             example: ['123 Main Street', '456 Side Street']
           instituteNames:
             description: The name of the institute to search for
             type: array
+            nullable: true
             items:
               type: string
             example: ['The Institute', 'The Other Institute']
           locationTypes: 
             description: The type of location this represents (ex. Breeding Location, Storage Location, etc)
             type: array
+            nullable: true
             items:
               type: string
             example: ['Nursery', 'Storage Location']
@@ -66,6 +75,7 @@ components:
               <br/> The Parent Location defines the encompassing location that this location belongs to. 
               For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.
             type: array
+            nullable: true
             items:
               type: string
             example: ['b28911cf', '5071d1e4']
@@ -75,6 +85,7 @@ components:
               <br/> The Parent Location defines the encompassing location that this location belongs to. 
               For example, an Institution might have multiple Field Stations inside it and each Field Station might have multiple Fields.
             type: array
+            nullable: true
             items:
               type: string
             example: ['Location Alpha', 'The Large Hadron Collider']

Specification/BrAPI-Core/People/Schemas/PersonNewRequest.yaml

@@ -13,38 +13,48 @@ components:
             type: string
           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.
           type: object
+          nullable: true
         description:
           description: description of this person
           type: string
+          nullable: true
           example: Bob likes pina coladas and getting caught in the rain. 
         emailAddress:
           description: email address for this person
           type: string
+          nullable: true
           example: bob@bob.com
         firstName:
           description: Persons first name
           type: string
+          nullable: true
           example: Bob
         lastName:
           description: Persons last name
           type: string
+          nullable: true
           example: Robertson
         mailingAddress:
           description: physical address of this person
           type: string
+          nullable: true
           example: 123 Street Ave, City, State, Country
         middleName:
           description: Persons middle name
           type: string
+          nullable: true
           example: Danger
         phoneNumber:
           description: phone number of this person
           type: string
+          nullable: true
           example: +1-555-555-5555
         userID:
           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.
           type: string
+          nullable: true
           example: bob-23
         externalReferences: 
           $ref: '#/components/schemas/ExternalReferences'
+          nullable: true
 

Specification/BrAPI-Core/People/Schemas/PersonSearchRequest.yaml

@@ -16,48 +16,56 @@ components:
           emailAddresses:
             description: email address for this person
             type: array
+            nullable: true
             items:
               type: string
             example: ['bob@bob.com', 'rob@bob.com']
           firstNames:
             description: Persons first name
             type: array
+            nullable: true
             items:
               type: string
             example: ['Bob', 'Rob']
           lastNames:
             description: Persons last name
             type: array
+            nullable: true
             items:
               type: string
             example: ['Robertson', 'Smith']
           mailingAddresses:
             description: physical address of this person
             type: array
+            nullable: true
             items:
               type: string
             example: ['123 Main Street', '456 Side Street']
           middleNames:
             description: Persons middle name
             type: array
+            nullable: true
             items:
               type: string
             example: ['Danger', 'Fight']
           personDbIds:
             description: Unique ID for this person
             type: array
+            nullable: true
             items:
               type: string
             example: ['1e7731ab', 'bc28cff8']
           phoneNumbers:
             description: phone number of this person
             type: array
+            nullable: true
             items:
               type: string
             example: ['9995555555', '8884444444']
           userIDs:
             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.
             type: array
+            nullable: true
             items:
               type: string
             example: ['bob', 'rob']

Specification/BrAPI-Core/Programs/Schemas/ProgramNewRequest.yaml

@@ -13,32 +13,39 @@ components:
         abbreviation:
           description: A shortened version of the human readable name for a Program
           type: string
+          nullable: true
           example: P1
         additionalInfo:
           additionalProperties:
             type: string
           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.
           type: object
+          nullable: true
         commonCropName:
           description: Common name for the crop which this program is for
           type: string
+          nullable: true
           example: Tomatillo
         documentationURL:
           description: A URL to the human readable documentation of an object
           format: uri
           type: string
+          nullable: true
           example: https://wiki.brapi.org
         leadPersonDbId:
           description: The unique identifier of the program leader
           type: string
+          nullable: true
           example: fe6f5c50
         leadPersonName:
           description: The name of the program leader
           type: string
+          nullable: true
           example: Bob Robertson
         objective:
           description: The primary objective of the program
           type: string
+          nullable: true
           example: Make a better tomatillo
         programName:
           description: Human readable name of the program
@@ -57,8 +64,10 @@ components:
         fundingInformation:
           description: Information describing the grant or funding source for this program
           type: string
+          nullable: true
           example: 'EU: FP7-244374'
         externalReferences: 
           $ref: '#/components/schemas/ExternalReferences'
+          nullable: true
 
 

Specification/BrAPI-Core/Programs/Schemas/ProgramSearchRequest.yaml

@@ -18,24 +18,28 @@ components:
             items:
               type: string
             type: array
+            nullable: true
             example: ['P1', 'P2']
           leadPersonDbIds:
             description: The person DbIds of the program leader to search for
             items:
               type: string
             type: array
+            nullable: true
             example: ['d8bd96c7', 'a2b9c8e7']
           leadPersonNames:
             description: The names of the program leader to search for
             items:
               type: string
             type: array
+            nullable: true
             example: ['Bob Robertson', 'Rob Robertson']
           objectives:
             description: A program objective to search for
             items:
               type: string
             type: array
+            nullable: true
             example: ['Objective Code One', 'This is a longer objective search query']
           programTypes:
             description: |-
@@ -48,4 +52,5 @@ components:
               - STANARD
               - PROJECT
             type: array
+            nullable: true
             example: ['STANARD', 'PROJECT']

Specification/BrAPI-Core/Seasons/Schemas/Season.yaml

@@ -18,6 +18,7 @@ components:
         seasonName:
           description: Name of the season. ex. 'Spring', 'Q2', 'Season A', etc.
           type: string
+          nullable: true
           example: Spring
         seasonDbId:
           description: The ID which uniquely identifies a season. For backward compatibility it can be a string like '2012', '1957-2004'
@@ -26,5 +27,6 @@ components:
         year:
           description: The 4 digit year of the season.
           type: integer
+          nullable: true
           example: 2018