Clarify entry/complete document terminology (3.0.4)#3820
Merged
miqui merged 1 commit intoOAI:v3.0.4-devfrom May 23, 2024
Merged
Clarify entry/complete document terminology (3.0.4)#3820miqui merged 1 commit intoOAI:v3.0.4-devfrom
miqui merged 1 commit intoOAI:v3.0.4-devfrom
Conversation
This was referenced May 19, 2024
miqui
previously approved these changes
May 21, 2024
Contributor
miqui
left a comment
There was a problem hiding this comment.
I pre-approve this. I deem the language here to be appropriate.
ralfhandl
previously approved these changes
May 22, 2024
Clarifies that there can be multiple complete OpenAPI documents, only one of which is an entry OpenAPI document.
Member
Author
|
Conflicts merged - it needs at least one re-approval to merge because pushing the conflict resolution unset both existing approvals. There is no change to the actual change here- there was just another change to different words on the same line. |
This was referenced May 22, 2024
ralfhandl
approved these changes
May 23, 2024
miqui
approved these changes
May 23, 2024
lornajane
added a commit
that referenced
this pull request
May 23, 2024
Clarify entry/complete document terminology (3.1.1 port of #3820)
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
3 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.
@ralfhandl caught that our phrasing here seemed to imply only one document with an OpenAPI Object, which was emphatically not the intention.
Clarifies that there can be multiple complete OpenAPI documents, only one of which is an entry OpenAPI document. The term "complete OpenAPI document" is useful in other guidance (to be tidied up in a later PR as it is currently only mentioned in 3.1.1).
Also added "entry document" as shorthand for "entry OpenAPI document" because I know I've used it that way and it reads better in some contexts.