Repository navigation
docs: document conditional requirement labels on API fields - #8337
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
brandonmcconnell
approved these changes
Nov 7, 2026
Merged
This branch was successfully deployed
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.
Explains how
if/then/else,dependentRequiredanddependentSchemasnow show "required if/unless" labels on endpoint fields, with the agent skill and the api-docs sdk instructions topic updated to match.Based on a merged change that labels conditionally required API fields. Duplicate check: open and recent docs PRs for "conditional", "OpenAPI", "required"; none found.
Note
Low Risk
Documentation-only updates; no runtime or security behavior changes.
Overview
Documents how OpenAPI 3.1 conditional requirements render in Mintlify so authors know what to expect on endpoint pages.
Adds a Conditional requirements subsection to the API reference skill (
api-docs.md):if/then/else,dependentRequired, anddependentSchemasdrive required pills with human-readable conditions (e.g.required if method = card,required unless,required if tax_id is set). It also notes when Mintlify shows a generic conditionally required label—complexiftests, or when a property tested inifcan be missing because it is not required.Expands Complex data types (
complex-data-types.mdx) with the same topic, a full YAML example (Payment), expected labels per field, summarization rules, and a<Tip>about markingif-tested properties as required for specific labels.Adds a single bullet to Advanced API and SDK reference instructions (
sdk.mdx) so SDK/OpenAPI workflows mention these conditional requirement pills and the same caveat about requiredifproperties.Reviewed by Cursor Bugbot for commit 15312a1. Bugbot is set up for automated code reviews on this repo. Configure here.