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.

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

Spruce up OpenApiResponse creation in Microsoft.AspNetCore.OpenApi package #41243

Closed
captainsafia opened this issue Apr 18, 2022 · 4 comments
Closed
Assignees
Labels
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 feature-openapi
Milestone

Comments

@captainsafia
Copy link
Member

With the introduction of the Microsoft.AspNetCore.OpenApi package, we carried over some logic for producing OpenApiResponses out of the metadata and attributes that a handler had that existing in the ApiExplorer.

This logic assumes some MVC-specific patterns and is fairly complex to reason about, especially when it comes to processing content types that are set on an endpoint.

The new package gives us an opportunity to break away from this tradition and adopt a more simplified hierarchy for how Produces attributes and metadata are processed on an endpoint.

@captainsafia captainsafia added enhancement This issue represents an ask for new feature or an enhancement to an existing one feature-openapi area-web-frameworks *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels labels Apr 18, 2022
@captainsafia captainsafia added this to the .NET 7 Planning milestone Apr 18, 2022
@ghost
Copy link

ghost commented Apr 18, 2022

Thanks for contacting us.

We're moving this issue to the .NET 7 Planning milestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).
If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

@captainsafia
Copy link
Member Author

Moving this to the backlog.

Changing up our response generation for minimal isn't going to add a ton of value and will likely introduce more bugs into this surface area.

We might even want to consider closing this all together unless we can design a radically simplified/approachable response generation strategy in the OpenAPI package.

@captainsafia captainsafia modified the milestones: .NET 7 Planning, Backlog May 31, 2022
@ghost
Copy link

ghost commented May 31, 2022

We've moved this issue to the Backlog milestone. This means that it is not going to be worked on for the coming release. We will reassess the backlog following the current release and consider this item at that time. To learn more about our issue management process and to have better expectation regarding different types of issues you can read our Triage Process.

@rafikiassumani-msft rafikiassumani-msft added the Docs This issue tracks updating documentation label Aug 4, 2022
@captainsafia
Copy link
Member Author

If we take the strategy outlined in #43675, we should see about removing the inference logic in the generator and relying on setting the metadata directly.

@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
@adityamandaleeka adityamandaleeka added the net8_docathon This issue is part of the documentation push in Fall 2023. label Aug 25, 2023
@captainsafia captainsafia removed Docs This issue tracks updating documentation net8_docathon This issue is part of the documentation push in Fall 2023. labels Aug 25, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Oct 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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 feature-openapi
Projects
None yet
Development

No branches or pull requests

3 participants