Re-worked OpenAPI spec (CADC 15042) - #213
Open
andamian wants to merge 20 commits into
Open
Conversation
added 9 commits
January 12, 2026 16:08
pdowler
requested changes
Apr 24, 2026
| @@ -0,0 +1,134 @@ | |||
| # Shared components for the GMS OpenAPI description (referenced from path fragments and the root document). | |||
| components: | |||
| parameters: | |||
Member
There was a problem hiding this comment.
parameter definition style:
I found one of:
- name: groupID
in: path
...
or (eg)
- $ref: {defined elsewhere}
to be the most compact. See VOSI.git for examples of params defined in separate files.
Having
groupID:
name: groupID
...
is either redundant or confusing when the two values differ.
Contributor
Author
There was a problem hiding this comment.
That works in service parameters but not in components. In components the first occurrence is a key and the second one is the name. Although appears to be a repetition, that is not necessarily so as we could use a different value such as groupIDKey for example. Would that make the intention more obvious?
added 10 commits
April 28, 2026 13:04
This file contains hidden or 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
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.
Renamed branch