Document custom parameter pills for API reference#5545
Merged
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
approved these changes
Apr 27, 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.
Summary
Documents a new feature that lets users render custom pill labels next to API parameter names in the API reference and playground.
api.params.postto thedocs.jsonAPI settings reference. List OpenAPI spec field keys (e.g.nullable,x-internal) and Mintlify renders the corresponding values as pills on every parameter.x-mint.preandx-mint.postto thex-mintextension reference. Use these on any schema to attach per-property pills before or after the parameter name.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.postpills, and introducesdocs.jsonsupport forapi.params.postto automatically surface selected OpenAPI field values as post pills (including rendering rules and an updated example). Updates thedocs.jsonsettings reference table and theapi.paramsproperty reference to includeapi.params.post.Reviewed by Cursor Bugbot for commit 3f1c4c5. Bugbot is set up for automated code reviews on this repo. Configure here.