docs: document overriding auto-generated Authorization description#6683
Open
mintlify[bot] wants to merge 5 commits into
Open
docs: document overriding auto-generated Authorization description#6683mintlify[bot] wants to merge 5 commits into
mintlify[bot] wants to merge 5 commits into
Conversation
…ed Authorization field text
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 8575b18. Configure here.
ethanpalm
reviewed
Jul 21, 2026
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
ethanpalm
reviewed
Jul 21, 2026
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.

Documentation changes
Adds a subsection to the OpenAPI setup page explaining that users can override the auto-generated
Authorizationfield description in the API playground by setting adescriptionon the security scheme in their OpenAPI spec. Customers frequently miss that this is customizable.Closes
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Generated by Mintlify Agent.
Requested by: hahnbee@mintlify.com via Slack
Mintlify session: slack_1784605763.271809_C0A6A37P2AK
Note
Low Risk
Documentation-only changes with no runtime or configuration behavior impact.
Overview
Documents how to replace Mintlify’s auto-generated Authorization playground help text by setting a
descriptionon the security scheme in OpenAPI (components.securitySchemes).The new API playground troubleshooting accordion explains that Markdown in that field applies on every endpoint using the scheme, with a bearer-auth JSON example.
openapi-setup.mdxonly drops an extra blank line—no new setup subsection in this diff.Reviewed by Cursor Bugbot for commit 89af6b1. Bugbot is set up for automated code reviews on this repo. Configure here.