v3.2: Move URI/URL resolution sections, *UNCHANGED*, under OAD Structure #4790
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
Almost all of our guidance on parsing and resolving OADs is under the section "OpenAPI Description Structure", _except_ for the parts on resolving relative OAD URI and API URL references. Those two sections are further down, after a lengthy discussion of data types. This moves (without any changes except heading levels) those URI/URL resolution sections up with all of the other parsing guidance. I have placed them before the "Implicit Connections" section because those connections are "Implicit" in contrast to URI references, which are explicit. This puts all of the parsing guidance in one place, and properly contextualizes "Implicit Connections" instead of introducing them before the far-more-common URI connections.
ralfhandl
approved these changes
Jul 17, 2025
lornajane
approved these changes
Jul 19, 2025
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.
Almost all of our guidance on parsing and resolving OADs is under the section "OpenAPI Description Structure", except for the parts on resolving relative OAD URI and API URL references. Those two sections are further down, after a lengthy discussion of data types.
This moves (without any changes except heading levels) those URI/URL resolution sections up with all of the other parsing guidance. I have placed them before the "Implicit Connections" section because those connections are "Implicit" in contrast to URI references, which are explicit.
This puts all of the parsing guidance in one place, and properly contextualizes "Implicit Connections" instead of introducing them before the far-more-common URI connections.
Before:
After: