-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
base: v3.2-dev
Are you sure you want to change the base?
Conversation
This adds a `summary` field to every Object that has a `description` field but did not already have `summary`.
There was a problem hiding this 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.
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. |
@lornajane my sense from the issue is that
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. |
My personal opinion is that if we're not prepared to consider this object-by-object, we should not merge this as-is, but instead revisit when we're ready to look at it all in detail. |
@lornajane Not sure what you mean by this? On more than one occasion, I have had tech writers (involved in API gov initiatives yay!!) share that summary and description are both essential components in technical documentation, (and more so when the API is to be eventually mature to be a product on its own). I don't in anyway presume to be a tech writer, but at least to me their point made a lot of sense. I would rather use a summary attribute than to leverage the new name attribute in the server object, for example. |
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 adescription
field but did not already havesummary
. As @LasneF noted in the linked issue, it makes sense for us to be consistent with these fields.