Render OpenAPI security scheme descriptions in the Authorization section#757
Open
krishna28004 wants to merge 1 commit into
Open
Render OpenAPI security scheme descriptions in the Authorization section#757krishna28004 wants to merge 1 commit into
krishna28004 wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #562
This PR enhances the Authorization section for OpenAPI reference pages by rendering the descriptions defined in
components.securitySchemesinstead of displaying authentication badges alone.For the Conversational AI APIs, it also enriches the security scheme descriptions with links to the existing authentication documentation and concrete authorization header examples, making the Join API self-contained for authentication guidance.
Type of Change
What Changed
basicAuthandtokenAuthsecurity scheme descriptions with:Authorizationheader examplesVerification
Notes for Reviewers
This implementation intentionally reuses the existing
components.securitySchemesmetadata rather than introducing new vendor extensions or operation-specific documentation. The renderer remains generic and automatically benefits any OpenAPI specification that provides security scheme descriptions.