Schema urgent fixes to main: type => set type and definitions -> $defs #183
+1,697
−919
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
main to dev
The OpenAPI `endpoints` files included a number of leftover or potentially misleading descripions, e.g.: * "get a list of..." as description for responses, although responses depend on granularity and delivered in different Beacon response schemas * frequent use of "variant" instead "variation" * some wrong labels (e.g. C&P errors or leftover "examples" response) Additionally the leftover commented lines from the yamlerRunner have been removed.
* clarifications, rewording, example * no schema changes
This aligns the use of the "definitions" parameter to the "$defs" keyword as required from https://json-schema.org/draft/2020-12/schema Editing of the YAML files with conversion... Additional changes include a change in the beaconYamler.py utility (use of system Python instead of fixed path) and a few updates of json files due to previous manual editing and now re-arranged parameter order after autoconversion from yaml.
Definitions to $defs
This addresses #159 - see comments there.
Endpoints description fixes
Changelog updated with 2.1.1 milestone
…gTerms-definitions remove conflicting specifications in filteringTerms
This fixes a well hidden example. Thanks to @Deepthi-v-s for #177
type => set type in example
Schema urgent fixes
This commit re-writes some of the root descriptions of the response type schemas (mostly) into slightly more verbose and formatted texts. Besides the "documentation is good" paradigm one reason is the intended use of these for generating documentation pages - see the (under construction) rendering at https://bycon.progenetix.org/generated/beacon-responses/
VRS references fix
update from main
VRS references from 1.2 => 1.3
Fix vrs schema link
refactoring "info" and its links
Adding links in changelog to point to each of the beacon v2 versions
Inline documentation updates
fix invalid aCollectionOf property definition
Invalid Syntax in `beaconErrorResponse.yaml` #135
Fixed invalid syntax in `examples` #140
Fixed invalid syntax in `securityLevels` #137
Fixed invalid syntax in `includeResultsetResponses` #136
Fixed invalid Syntax in `filtering_terms` response #138
jrambla
approved these changes
Dec 12, 2024
gsfk
approved these changes
Dec 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Opening the official push of the last schema urgent fixes to main, just to take the initiative. We will need to find in which milestone we suit this and tag it before merging.