Skip to content

docs: document overriding auto-generated Authorization description#6683

Open
mintlify[bot] wants to merge 5 commits into
mainfrom
mintlify/71a9774b
Open

docs: document overriding auto-generated Authorization description#6683
mintlify[bot] wants to merge 5 commits into
mainfrom
mintlify/71a9774b

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Adds a subsection to the OpenAPI setup page explaining that users can override the auto-generated Authorization field description in the API playground by setting a description on 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

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

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 description on 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.mdx only 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.

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 21, 2026, 3:52 AM

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 21, 2026, 3:52 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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.

Comment thread api-playground/troubleshooting.mdx Outdated
Comment thread api-playground/troubleshooting.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread api-playground/troubleshooting.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants