Skip to content

Document custom parameter pills for API reference#5545

Merged
ehcaw merged 1 commit intomainfrom
mintlify/openapi-param-pills-1777317057
Apr 27, 2026
Merged

Document custom parameter pills for API reference#5545
ehcaw merged 1 commit intomainfrom
mintlify/openapi-param-pills-1777317057

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 27, 2026

Summary

Documents a new feature that lets users render custom pill labels next to API parameter names in the API reference and playground.

  • Adds api.params.post to the docs.json API settings reference. List OpenAPI spec field keys (e.g. nullable, x-internal) and Mintlify renders the corresponding values as pills on every parameter.
  • Adds x-mint.pre and x-mint.post to the x-mint extension reference. Use these on any schema to attach per-property pills before or after the parameter name.
  • Updates the settings reference table and the property reference with the new field.

Triggering PR

Documents the feature shipped in mint#7262, which extends the OpenAPI playground to surface arbitrary spec fields and per-schema annotations as pill labels.


Note

Low Risk
Low risk documentation-only change that adds new configuration/extension references without modifying runtime behavior.

Overview
Documents new ways to annotate OpenAPI parameters with custom pill labels in the API reference and playground.

Adds docs for per-schema x-mint.pre/x-mint.post pills, and introduces docs.json support for api.params.post to automatically surface selected OpenAPI field values as post pills (including rendering rules and an updated example). Updates the docs.json settings reference table and the api.params property reference to include api.params.post.

Reviewed by Cursor Bugbot for commit 3f1c4c5. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify-development
Copy link
Copy Markdown
Contributor

mintlify-development Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
userauth 🟢 Ready View Preview Apr 27, 2026, 7:19 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 27, 2026, 7:18 PM

@ehcaw ehcaw merged commit 6c4c23c into main Apr 27, 2026
6 checks passed
@ehcaw ehcaw deleted the mintlify/openapi-param-pills-1777317057 branch April 27, 2026 22:17
@ethanpalm ethanpalm self-requested a review April 27, 2026 22:18
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.

3 participants