Clarify constraints on Parameter Object fields (3.0.4) #3760
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
example
andexamples
(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
content
vsschema
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
andexamples
is moved to the section onschema
and related parameters as it appears to only apply in that case.