feat: adds description field to overlay info object #233
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
Signed-off-by: Vincent Biret <[email protected]>
Signed-off-by: Vincent Biret <[email protected]>
ralfhandl
reviewed
Nov 5, 2025
Contributor
|
Please add a description to the pull request. What benefit does this change have, why would we do it? |
Member
Author
|
@lornajane sorry, CLI monkey here. Updated the original comment. Let me know if you have any additional comments or questions. |
mikekistler
approved these changes
Nov 6, 2025
Contributor
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
Looks good. 👍
Seems like a useful addition to me.
ralfhandl
approved these changes
Nov 6, 2025
lornajane
approved these changes
Nov 16, 2025
Contributor
lornajane
left a comment
lornajane
left a comment
There was a problem hiding this comment.
Nice, we're already using it 😆
Contributor
|
Also Vincent if you can't write a pull request description from the command line then you need to see me after class! |
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.
This pull request adds a description field to the info object.
While working on implementing additional tests in clio, I discovered that one of the compliant tests was actually non compliant with the specification (see #232).
Having a description field in the info object aligns with the OpenAPI specification and seems to be desirable given we (spec authors) already "started using this field".
While chatting this over with @ralfhandl I originally suggested to also add a summary field to align with OpenAPI further. He was not sold on the idea. Happy either way based on the feedback here. Let me know and I'll add this other field as well to the pull request.