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

Create Web API: v9 update sample update and rewrite for VSC version OpenAPI UI gen #33001

Closed
wadepickett opened this issue Jul 5, 2024 · 4 comments
Assignees
Labels
9.0 .NET 9 aspnet-core/svc okr-health Content health internal initiative seQUESTered Identifies that an issue has been imported into Quest. Source - Docs.ms Docs Customer feedback via GitHub Issue tutorials/subsvc

Comments

@wadepickett
Copy link
Contributor

wadepickett commented Jul 5, 2024

Description

Update to .NET 9. using .NET 9 template and latest for OpenAPI

Instruction for older versions needs to indicate the version of the Nuget package to select, or simply state to choose the latest version available to match the project target.

Update the code and content for the VSC tab version to use a recommended OpenAPI UI gen with v9 such as scalar or move to curl.

Page URL

https://learn.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-9.0&tabs=visual-studio#scaffold-a-controller-1

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/tutorials/first-web-api.md

Document ID

95f2549e-29f9-e31a-b4d0-432b971643ff

Article author

@wadepickett


Associated WorkItem - 291122

@wadepickett wadepickett added Source - Docs.ms Docs Customer feedback via GitHub Issue ⌚ Not Triaged 9.0 .NET 9 labels Jul 5, 2024
@wadepickett wadepickett self-assigned this Jul 5, 2024
@wadepickett wadepickett added okr-health Content health internal initiative reQUEST Triggers an issue to be imported into Quest labels Jul 29, 2024
@sequestor sequestor bot added seQUESTered Identifies that an issue has been imported into Quest. and removed reQUEST Triggers an issue to be imported into Quest labels Jul 30, 2024
@wadepickett
Copy link
Contributor Author

wadepickett commented Aug 27, 2024

Note: Might be partially blocked on this one as I am trying to complete it at the end of the sprint, until I have an OK on using an OpenAPI UI generation package such as scalar.

Looking for a decision here in the disucssion here: #32477#issuecomment-2313663431

So far I have done the pre-work for versioning, and new versions of the app sample to the point of adding a UI generation package for OpenAPI and updating the content down to the point section for testing out the API.

Instructions and screenshots from the test section on down for the VSC tab version will have to be rewritten. We were using swaggerUI before.

If using the Scalar.AspNetCore package for generating UI, it would be pointed to the OpenAPI generated .json output (This would be enabled for the dev environment only as was also pointed out here: Work with OpenAPI documents | Microsoft Learn

@wadepickett wadepickett changed the title Create Web API: v9 update v8 sample update and specify latest matching NuGet package versions Create Web API: v9 update v8 sample update and rewrite for VSC version OpenAPI UI gen Aug 27, 2024
@wadepickett
Copy link
Contributor Author

wadepickett commented Aug 28, 2024

Per discussion #32477 (comment) , since we already have a swaggerUI demonstrated with version 8 for folks to refer to, we will go scalar for v9.

However, with just one more day left of this monthly sprint (August) I am not going to be able to finish this one and we have higher priority security related triaging to still get through first. So moving this to September.

@dotnetrepoman dotnetrepoman bot added mapQuest clean move and removed mapQuest clean move labels Oct 1, 2024
@wadepickett wadepickett moved this from 🔖 Ready to 🏗 In progress in dotnet/AspNetCore.Docs January 2025 sprint Jan 23, 2025
@dotnetrepoman dotnetrepoman bot added the mapQuest clean move label Jan 23, 2025
@dotnet-policy-service dotnet-policy-service bot removed the mapQuest clean move label Jan 23, 2025
@wadepickett wadepickett moved this from 🔖 Ready to 🏗 In progress in dotnet/AspNetCore.Docs February 2025 sprint Feb 10, 2025
@dotnetrepoman dotnetrepoman bot added the mapQuest clean move label Feb 10, 2025
@dotnet-policy-service dotnet-policy-service bot removed the mapQuest clean move label Feb 10, 2025
@wadepickett wadepickett moved this from 🏗 In progress to 👀 In review in dotnet/AspNetCore.Docs February 2025 sprint Feb 20, 2025
@dotnetrepoman dotnetrepoman bot added the mapQuest clean move label Feb 20, 2025
@dotnet-policy-service dotnet-policy-service bot removed the mapQuest clean move label Feb 20, 2025
@wadepickett
Copy link
Contributor Author

There were two community PR's going on at the same time for this. We ended up closing one and moving what was done there to the other here: #34746

@wadepickett wadepickett changed the title Create Web API: v9 update v8 sample update and rewrite for VSC version OpenAPI UI gen Create Web API: v9 update sample update and rewrite for VSC version OpenAPI UI gen Feb 20, 2025
@wadepickett
Copy link
Contributor Author

Closed as fixed by #34746

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
9.0 .NET 9 aspnet-core/svc okr-health Content health internal initiative seQUESTered Identifies that an issue has been imported into Quest. Source - Docs.ms Docs Customer feedback via GitHub Issue tutorials/subsvc
Projects
Development

Successfully merging a pull request may close this issue.

2 participants