Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema urgent fixes #179

Merged
merged 13 commits into from
Nov 11, 2024
Merged

Conversation

mbaudis
Copy link
Member

@mbaudis mbaudis commented Nov 11, 2024

bringing inline doc updates branch up to current state

mbaudis and others added 13 commits July 17, 2024 13:47
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.
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.
This addresses #159 - see comments there.
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
@mbaudis mbaudis merged commit 31b5063 into inline-documentation-updates Nov 11, 2024
1 check passed
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.

3 participants