Skip to content

662 update the json schema due to changes in the schema tools - #684

Open
guydavenport wants to merge 89 commits into
brapi-V2.1from
662-update-the-json-schema-due-to-changes-in-the-schema-tools
Open

662 update the json schema due to changes in the schema tools#684
guydavenport wants to merge 89 commits into
brapi-V2.1from
662-update-the-json-schema-due-to-changes-in-the-schema-tools

Conversation

@guydavenport

Copy link
Copy Markdown
Contributor

Various changes to align V2.1 with the json schema

Guy Davenport and others added 30 commits January 28, 2026 13:00
…transactions. This avoids changing the model in this version.
- Changed -c parameter from 'Specification/Components' to 'Specification/OpenAPI-Components'
- This ensures consistency with generateOpenAPI and generateOpenAPIJSON tasks
- Fixes discrepancy between local and CI-generated comparison files
…-tools' of github_guy:plantbreeding/BrAPI into 662-update-the-json-schema-due-to-changes-in-the-schema-tools
Guy Davenport and others added 8 commits June 6, 2026 20:35
…ges-in-the-schema-tools

# Conflicts:
#	Specification/BrAPI-Schema/BrAPI-Common/GeoJSONGeometry.json
#	Specification/BrAPI-Schema/BrAPI-Core/Study.json
#	Specification/BrAPI-Schema/BrAPI-Phenotyping/Image.json
#	Specification/BrAPI-Schema/Requests/AlleleMatrixRequest.json
#	Specification/BrAPI-Schema/Requests/SeedLotTransactionRequest.json
#	Specification/Generated/BrAPI-Core.yaml
#	Specification/Generated/BrAPI-Genotyping.yaml
#	Specification/Generated/BrAPI-Germplasm.yaml
#	Specification/Generated/BrAPI-Phenotyping.yaml
#	Specification/Generated/brapi_generated.graphqls
#	Specification/Generated/brapi_generated.json
#	Specification/Generated/brapi_openapi_comparison.md
#	generator/build.gradle
…o-changes-in-the-schema-tools' into 662-update-the-json-schema-due-to-changes-in-the-schema-tools
Guy Davenport added 21 commits August 23, 2026 12:56
…initions

- Upgraded OpenAPI version from 3.0.0 to 3.1.0 across multiple schema files.
- Modified nullable properties to use 'null' type in VariableBaseClass schema.
- Improved descriptions and formatting in geoJSON, geoJSONSearchArea, and metadata schemas.
- Updated pagination parameters to clarify usage and deprecated tokens.
- Enhanced documentation for authorization headers and external references.
- Cleaned up whitespace and formatting inconsistencies throughout the specification files.
- Added example values for fields in Plate.json, Sample.json, Cross.json, CrossType.json, CrossingProject.json, Germplasm.json, GermplasmAttributeValue.json, PlannedCross.json, SeedLot.json, SeedLotTransaction.json, Image.json, Method.json, Observation.json, ObservationUnit.json, ObservationVariable.json, Ontology.json, Scale.json, and Trait.json.
- Improved clarity and usability of the schema by providing concrete examples for string, integer, and other data types.
…e schema and deprecate 'max' and 'min' fields in Scale schema
…with embeddedPrimaryIdOptionalFor properties
- Updated the brapi_openapi_comparison.md to reflect changes in response types and properties for several endpoints including /observationunits, /referencesets, and /samples.
- Added new properties and removed obsolete ones to ensure accurate API documentation.
- Modified openapi-options.yaml and openapi-single-file-options.yaml to include subPathPagedToken settings for GET requests, enhancing the generator's capabilities.
…o replace 'get' with 'getWithId' for improved response handling
…e properties for ObservationUnit in OpenAPI options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant