Refactor security scheme naming in AuthDocumentTransformer#158
Merged
marcominerva merged 1 commit intomasterfrom Jun 19, 2025
Merged
Refactor security scheme naming in AuthDocumentTransformer#158marcominerva merged 1 commit intomasterfrom
marcominerva merged 1 commit intomasterfrom
Conversation
Updated the naming convention for security schemes in the
`AuthenticationDocumentTransformer` class. The new format
appends a suffix to the scheme name (e.g., "-Header" and
"-QueryString") instead of using descriptive phrases. This
change enhances consistency and clarity in the generated
documentation for both header and query string security schemes.
Refactor security scheme naming in OpenAPI document
This update changes the naming convention for security schemes added to the OpenAPI document. Instead of descriptive strings that include the scheme name and location, the new implementation appends a suffix to the scheme name (e.g., `"{settings.SchemeName}-Header"` for headers and `"{settings.SchemeName}-QueryString"` for query strings). This improves consistency, clarity, and maintainability of the security scheme definitions.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Updated the naming convention for security schemes in the
AuthenticationDocumentTransformerclass. The new format appends a suffix to the scheme name (e.g., "-Header" and "-QueryString") instead of using descriptive phrases. This change enhances consistency and clarity in the generated documentation for both header and query string security schemes.Refactor security scheme naming in OpenAPI document
This update changes the naming convention for security schemes added to the OpenAPI document. Instead of descriptive strings that include the scheme name and location, the new implementation appends a suffix to the scheme name (e.g.,
"{settings.SchemeName}-Header"for headers and"{settings.SchemeName}-QueryString"for query strings). This improves consistency, clarity, and maintainability of the security scheme definitions.