Change OpenAPI document name resolution to be case-insensitive #59199
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
old-area-web-frameworks-do-not-use
dotnet-policy-service
bot
added
the
community-contribution
martincostello
added
feature-openapi
area-minimal
dotnet-policy-service
bot
added
the
pending-ci-rerun
captainsafia
reviewed
Dec 9, 2024
src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
captainsafia
reviewed
Dec 9, 2024
.../Microsoft.AspNetCore.OpenApi.Tests/Extensions/OpenApiEndpointRouteBuilderExtensionsTests.cs
Show resolved
Hide resolved
mkArtakMSFT
removed
the
old-area-web-frameworks-do-not-use
captainsafia
approved these changes
Dec 16, 2024
4 tasks
captainsafia
pushed a commit
that referenced
this pull request
Feb 11, 2025
* Fix analyser error * Wrote unit test to verify when bug is fixed * Register document names in a case-insensitive manner * Change OpenAPI document name resolution to be case-insensitive * Restore AddOpenApiCore to its own method * Fix typo in extension method
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change OpenAPI document name resolution to be case-insensitive
Case-sensitive urls are now supported when retrieving OpenAPI documents.
Description
There was a routing issue when using case-sensitive document names in
Microsoft.AspNetCore.OpenApi'sAddOpenApi()andMapOpenApi()methods. If you registered a document in a case-sensitive manner (MyDocument) and tried to retrieve it at/openapi/mydocument.json, it would result in a 404.This is odd, as ASP.NET Core's routing has always been case-insensitive by default.
The reason for this bug is that keyed services are used to register relevant services. The key is the document name, and keyed services are case-sensitive.
This PR changes this inconsistent behaviour by allowing case-insensitive document resolution by invariantly lowercasing both the registered document name and the document name that's being retrieved.
Fixes #59175