Skip to content

v3.2: Support summary alongside every description #4610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v3.2-dev
Choose a base branch
from

Conversation

handrews
Copy link
Member

NOTE: For this PR, if everyone reacts with "yeah let's do this!" then we should put it in 3.2. If it's controversial, I'm fine with bumping it for further consideration. I spent about 10 minutes on this PR, which was faster than asking anyone if I should do it.

Fixes #1591.

This adds a summary field to every Object that has a description field but did not already have summary. As @LasneF noted in the linked issue, it makes sense for us to be consistent with these fields.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

This adds a `summary` field to every Object that has
a `description` field but did not already have `summary`.
@handrews handrews added this to the v3.2.0 milestone May 18, 2025
@handrews handrews requested review from a team as code owners May 18, 2025 01:48
@handrews handrews added enhancement metadata tags, info, license, contact, markdown usage, etc. labels May 18, 2025
Copy link
Contributor

@miqui miqui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@handrews >> if everyone reacts with "yeah let's do this!" then we should put it in 3.2

+1 for this and IMHO should not be controversial itself. I believe this makes the overall spec more consistent.

@ralfhandl ralfhandl requested a review from a team May 19, 2025 12:06
@ralfhandl ralfhandl requested a review from a team May 19, 2025 12:12
@lornajane
Copy link
Contributor

I don't think this makes sense in every context, honestly, people don't use one field for words, so I don't think the users need two (parameters are a particular bald patch). However we already made this change for tags, and I think for security schemes, servers and responses it does make sense partly because those are often displayed in a condensed, pick-one format, which is where the summary fields are most needed.

@handrews
Copy link
Member Author

@lornajane my sense from the issue is that

  1. It definitely makes sense for more places than we had it in 3.1
  2. It is the lowest-effort sort of field to support
  3. It's easier to just be consistent than to debate every possible location in detail (example: You did not include
  4. Consistency in the data structure allows consistency in UIs and other handling

That said, whatever the TSC decides on this is fine with me. I'm not interested in debating this Object by Object so if you and others want to I'll leave you to it. I think this comment covers everything I have to say on this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement metadata tags, info, license, contact, markdown usage, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants