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

Update getting-started-with-swashbuckle.md #31441

Merged
merged 10 commits into from
Jan 17, 2024
Merged

Conversation

Rick-Anderson
Copy link
Contributor

@Rick-Anderson Rick-Anderson commented Jan 12, 2024

@Rick-Anderson
Copy link
Contributor Author

@tdykstra I'd rather just hide the topic for .NET 8 and higher, but that doesn't work.

Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One idea for you to consider.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about changing the file metadata from

monikerRange: '>= aspnetcore-3.1'

to

monikerRange: '>= aspnetcore-3.1 < aspnetcore-8.0'

That would at least get it out of the TOC.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about changing the file metadata from

monikerRange: '>= aspnetcore-3.1'

to

monikerRange: '>= aspnetcore-3.1 < aspnetcore-8.0'

That would at least get it out of the TOC.

That was my first try, and at least in the review URL, it still showed up in the TOC.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tdykstra take a look, it still shows up in the TOC.

@tdykstra
Copy link
Contributor

With "< aspnetcore-8.0" in the file metadata you don't need the < aspnetcore-8.0 block in the text. It always switches to 7.0 when you try to go to 8.0.

@Rick-Anderson
Copy link
Contributor Author

It's still not a great user experience if you land on that page so I added the warning back.

@Rick-Anderson
Copy link
Contributor Author

Can you fix the file? Just edit it.

@tdykstra
Copy link
Contributor

OK I think it's ready to go now:

  • If you try to go to the page with 8.0+ selected, it automatically kicks you back to 7.0.
  • All versions warn that it's not supported in 8.0+

@Rick-Anderson Rick-Anderson merged commit 4ae27ec into main Jan 17, 2024
3 checks passed
@Rick-Anderson Rick-Anderson deleted the Rick-Anderson-patch-7 branch January 17, 2024 00:19
@Rick-Anderson
Copy link
Contributor Author

All versions warn that it's not supported in 8.0+
That's good. Even if you're still on 6 or 7, better to get a warning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swashbuckle is not supported on .NET 8
2 participants