The Wayback Machine - https://web.archive.org/web/20220201224020/https://github.com/dotnet/aspnetcore/issues/39927
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

Jump to bottom

Support XML-based OpenAPI docs for minimal APIs #39927

Open
1 task done
captainsafia opened this issue Feb 1, 2022 · 1 comment
Open
1 task done

Support XML-based OpenAPI docs for minimal APIs #39927

captainsafia opened this issue Feb 1, 2022 · 1 comment
Labels
area-web-frameworks feature-minimal-actions feature-openapi
Milestone
.NET 7 Planning

Comments

@captainsafia
Copy link
Contributor

@captainsafia captainsafia commented Feb 1, 2022 •
edited

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

Swashbuckle currently supports reading the XML doc string associated with an action's method to derive the description, summary, example, etc for an action.

We need to add similar support for minimal endpoints where the documentation might be on a referenced method group or (maybe) on a MapAction invocation.

Expected Behavior

/// <summary>
/// This is a foo.
/// </summary>
string GetFoo() => "This is a test";

Should resolve the correct summary info.
@rafikiassumani-msft rafikiassumani-msft added this to the .NET 7 Planning milestone Feb 1, 2022
@msftbot
Copy link
Contributor

@msftbot msftbot bot commented Feb 1, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-web-frameworks feature-minimal-actions feature-openapi
Projects
None yet
Milestone
.NET 7 Planning
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@captainsafia @rafikiassumani-msft