Skip to content
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.

Sign up for GitHub

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

Jump to bottom

New Descripton Parameter for Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute Class #17608

Closed
ghost opened this issue Dec 5, 2019 · 6 comments
Closed

New Descripton Parameter for Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute Class #17608

ghost opened this issue Dec 5, 2019 · 6 comments
Labels
affected-very-few This issue impacts very few customers area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates enhancement This issue represents an ask for new feature or an enhancement to an existing one good first issue Good for newcomers. help candidate Indicates that the issues may be a good fit for community to help with. Requires work from eng. team severity-nice-to-have This label is used by an internal tool
Milestone
Backlog

Comments

@ghost
Copy link

ghost commented Dec 5, 2019 •
edited by ghost
Loading

Is your feature request related to a problem? Please describe.

Right now documenting API's can be more of a struggle than it needs to be. The OpenAPi documentation tool chain often relies on getting a description from XML comments result code. Ideally result code comments wouldn't be needed in most cases.

Describe the solution you'd like

Would it be possible to add an optional Description parameter to ProducesResponseTypeAttribute. The purpose of this description would be to override the default HTTP response description. This would be a nice benefit when documenting API controllers..
@javiercn javiercn added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Dec 5, 2019
@mkArtakMSFT mkArtakMSFT added this to the Backlog milestone Dec 5, 2019
@mkArtakMSFT mkArtakMSFT added enhancement This issue represents an ask for new feature or an enhancement to an existing one PRI: 3 - Optional labels Dec 5, 2019
@mkArtakMSFT
Copy link
Member

Thanks for contacting us. Such a change will actually span across multiple repos including external ones we don't own. Besides, this is not a priority for us at the moment. So if you would like to send PRs for the end-to-end scenario to light up, we would happily consider it. For now, we're moving this to backlog for future consideration.

@javiercn javiercn added good first issue Good for newcomers. help wanted Up for grabs. We would accept a PR to help resolve this issue severity-nice-to-have This label is used by an internal tool affected-very-few This issue impacts very few customers labels Oct 9, 2020
@willwolfram18
Copy link

I'd be interested in looking at this. I've run into this issue myself and wouldn't mind taking a crack at adding this capability!

I'm getting familiar with the contribution guidelines and building from source documentation, I'll check back in after getting that going.

@pranavkm pranavkm added area-web-frameworks *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels and removed area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates labels Oct 19, 2021
@abc516
Copy link
Contributor

abc516 commented May 20, 2023

Hi @mkArtakMSFT @pranavkm, is this still a valid open issue? I'm open to taking it on.

@captainsafia captainsafia added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed area-web-frameworks *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels labels Jun 20, 2023
@mkArtakMSFT mkArtakMSFT added help candidate Indicates that the issues may be a good fit for community to help with. Requires work from eng. team and removed help wanted Up for grabs. We would accept a PR to help resolve this issue labels Oct 28, 2023
@captainsafia
Copy link
Member

Closing in favor of #55656.

@sander1095
Copy link

Thanks @captainsafia ! I wont be able to work on this the next month because of holiday, but my offer to work on this still stands if i can get some help with the api changes that need to be made :)

@captainsafia
Copy link
Member

Thanks @captainsafia ! I wont be able to work on this the next month because of holiday, but my offer to work on this still stands if i can get some help with the api changes that need to be made :)

Yep -- I need to make some updates to the proposal so that we apply the changes to the minimal API-based metadata as well. If all goes well, I'll bring it up during API review on Thursday. However, at this point, it's likely to go into .NET 10 and not .NET 9 :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
affected-very-few This issue impacts very few customers area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates enhancement This issue represents an ask for new feature or an enhancement to an existing one good first issue Good for newcomers. help candidate Indicates that the issues may be a good fit for community to help with. Requires work from eng. team severity-nice-to-have This label is used by an internal tool
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
7 participants
@pranavkm @captainsafia @javiercn @sander1095 @willwolfram18 @abc516 @mkArtakMSFT