Clarify constraints on Parameter Object fields (3.0.4) #3760
Conversation
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
handrews
added
clarification
ralfhandl
approved these changes
Apr 29, 2024
This makes the relational requirements of `content` vs `schema` and associated fields more clear. The mutual exclusivity requirement is moved up to the top of the Fixed Fields section, and each table table is given a subsection clarifying its meaning. This makes it easier to follow the multi-table format, which is unusual within the OAS. The commentary on `example` and `examples` is moved to the section on `schema` and related parameters as it appears to only apply in that case.
mikekistler
approved these changes
May 6, 2024
Contributor
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
Looks good. 👍
I was not involved in the 3.0 spec development but I think these changes present the two alternatives for parameter description in a clearer way.
miqui
approved these changes
May 9, 2024
This was referenced May 9, 2024
ralfhandl
added a commit
that referenced
this pull request
May 14, 2024
Clarify constraints on Param Obj fields (3.1.1 port of #3760)
ralfhandl
added a commit
that referenced
this pull request
May 14, 2024
Clarify constraints on Param Obj fields (3.2.0 port of #3760)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #1542
I'm actually uncertain if
exampleandexamples(or, for that matter,allowReserved) are really only allowed withschema, but that seems to be what's implied by the existing text? I'm happy to rearrange this if it's not quite right.As usual, I will forward-port if accepted.
Commit Message:
This makes the relational requirements of
contentvsschemaand associated fields more clear. The mutual exclusivity requirement is moved up to the top of the Fixed Fields section, and each table table is given a subsection clarifying its meaning. This makes it easier to follow the multi-table format, which is unusual within the OAS.The commentary on
exampleandexamplesis moved to the section onschemaand related parameters as it appears to only apply in that case.