Simplify Swagger authentication field headers to "User Login" #1064
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.
Problem
The Swagger UI authentication section displayed a technical and user-unfriendly header text "OAuth2PasswordOrClientCredentialsBearer (OAuth2, password)" which was confusing for end users trying to authenticate with the API.
Solution
Added JavaScript code to the existing Swagger UI customization that:
nmdcInit
event (as suggested in the issue)Implementation Details
The change is minimal and surgical - only 15 lines of JavaScript added to
/nmdc_runtime/api/swagger_ui/assets/script.js
. The modification:nmdcInit
event infrastructure already in placeTesting
Created and tested a standalone HTML page that simulates the authentication section behavior. The test confirms that the text replacement works correctly for both the full technical text and shortened versions.
This change significantly improves the usability of the Swagger UI by making the authentication section more accessible and less intimidating for end users.
Fixes #895.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.