Endpoints description fixes #148
Merged
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
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.
|
Pinging @datsirul here FYI. |
costero-e
reviewed
Jul 17, 2024
There was a problem hiding this comment.
Great @mbaudis !, I see variants for genomic variations and list for beacon response are the main changes. I am not an expert on terminology but if this fits better to the spec, it's good.
The only thing I have seen is maybe the Get a *analyses* response for one experimental run, identified by its which could be an analyses, like Get an *analyses* response for one experimental run, identified by its.
jrambla
approved these changes
Jul 18, 2024
costero-e
approved these changes
Oct 8, 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.
The OpenAPI
endpointsfiles included a number of leftover or potentially misleading descriptions, e.g.:Additionally the leftover commented lines from the yamlerRunner have been removed.
These are non-breaking changes, restricted to the
descriptionfields inendpointsfiles. JSON versions were generated from YAML sources.