Clarify resolving implicit connections (3.1.1 - ALTERNATIVE to #3823) #3855
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.
This clarifies how to handle resolving implicit (non-URI-based) connections in multi-document OpenAPI Descriptions.
While the behavior is implementation-defined overall, this RECOMMENDS a single approach based on how things behaved going back to the 2.0 referencing model. This allows Security Schemes and Tags to (like the top-level Server Objects) define a deployment-specific interface for referenced documents to access.
This entry document interface approach makes less sense for the Discriminator Object, but it can use the URI syntax of
mapping
to keep things within the local document.This also aligns the search for matching
operationId
s with 3.1's full-document parsing requirements.Note that the term "complete OpenAPI document" has been defined in another change pending approval on the 3.0.4 branch.