Skip to content

Document parameter labels and api.params.post#5544

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/document-paramfield-pills-1777317007
Closed

Document parameter labels and api.params.post#5544
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/document-paramfield-pills-1777317007

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 27, 2026

Summary

Documents a new feature that lets users add custom labels next to a parameter's type in the API reference and playground.

  • Adds a "Parameter labels" section to api-playground/openapi-setup.mdx covering the new x-mint.pre and x-mint.post extensions on OpenAPI schema properties, with an example.
  • Documents the new api.params.post setting in organize/settings-api.mdx for surfacing arbitrary OpenAPI fields (including custom x- extensions) as labels on every parameter, with value-type rules and the existing example updated.

Triggering change

Adds support for mapping OpenAPI spec fields onto parameter labels in the playground. Users can configure a list of schema field keys in docs.json to render as labels, or set per-property labels via x-mint.pre / x-mint.post.


Note

Low Risk
Low risk documentation-only change describing new parameter label configuration and updating examples; no runtime or security-sensitive code is modified.

Overview
Adds documentation for parameter type labels in the API reference/playground, describing per-property labels via OpenAPI x-mint.pre/x-mint.post (with an example) and noting automatic readOnly/writeOnly labels.

Documents the new docs.json setting api.params.post to surface specified OpenAPI schema fields (including custom x- extensions) as labels across all parameters, and updates the api.params example to include post.

Reviewed by Cursor Bugbot for commit 40b7bc5. 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:16 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:15 PM

@ethanpalm
Copy link
Copy Markdown
Collaborator

Closing as duplicate of #5545. Both PRs document the same x-mint.pre/x-mint.post and api.params.post parameter label feature. PR #5545 is more comprehensive, including a full api.params.post JSON example and pill ordering details. Please review #5545 instead.

@ethanpalm ethanpalm closed this Apr 27, 2026
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