Document parameter labels and api.params.post#5544
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Document parameter labels and api.params.post#5544mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
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.
|
Collaborator
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 add custom labels next to a parameter's type in the API reference and playground.
api-playground/openapi-setup.mdxcovering the newx-mint.preandx-mint.postextensions on OpenAPI schema properties, with an example.api.params.postsetting inorganize/settings-api.mdxfor surfacing arbitrary OpenAPI fields (including customx-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.jsonto render as labels, or set per-property labels viax-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 automaticreadOnly/writeOnlylabels.Documents the new
docs.jsonsettingapi.params.postto surface specified OpenAPI schema fields (including customx-extensions) as labels across all parameters, and updates theapi.paramsexample to includepost.Reviewed by Cursor Bugbot for commit 40b7bc5. Bugbot is set up for automated code reviews on this repo. Configure here.