docs: document overriding auto-generated Authorization description#6683
docs: document overriding auto-generated Authorization description#6683mintlify[bot] wants to merge 3 commits into
Conversation
…ed Authorization field text
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
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.
| <Accordion title="The Authorization field description is generic or unhelpful"> | ||
| Mintlify auto-generates a description for the `Authorization` field in the API playground based on the security scheme type. Override it by adding a `description` to the security scheme in your OpenAPI specification. | ||
|
|
||
| ```json {7} theme={null} |
There was a problem hiding this comment.
Accidental code fence theme attribute
Low Severity
The new code fence includes theme={null}, which does not appear elsewhere in the docs and is not a documented Mintlify code-block meta option. It looks like leftover agent scaffolding rather than intentional docs markup.
Reviewed by Cursor Bugbot for commit 8575b18. Configure here.
1 participant
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 edits with no runtime or security impact.
Overview
Adds troubleshooting guidance for when the API playground shows a generic
Authorizationfield description: set adescriptionon the relevantsecuritySchemesentry in the OpenAPI spec (with a bearer example), note that Markdown is supported, and that the text applies on every endpoint using that scheme.The only change in
openapi-setup.mdxis removing an extra blank line before the download-spec section; the override behavior is not added there in this diff.Reviewed by Cursor Bugbot for commit 8575b18. Bugbot is set up for automated code reviews on this repo. Configure here.