Skip to content

docs: document conditional requirement labels on API fields - #8337

Merged
brandonmcconnell merged 1 commit into
mainfrom
autopilot/22163f33
Nov 7, 2026
Merged

brandonmcconnell merged 1 commit into
mainfrom
autopilot/22163f33

Conversation

@mintlify

@mintlify mintlify Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Explains how if/then/else, dependentRequired and dependentSchemas now 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, and dependentSchemas drive 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—complex if tests, or when a property tested in if can 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 marking if-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 required if properties.

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

@mintlify

mintlify Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 7, 2026, 12:01 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@brandonmcconnell
brandonmcconnell merged commit 36cb6f8 into main Nov 7, 2026
8 checks passed
@brandonmcconnell
brandonmcconnell deleted the autopilot/22163f33 branch November 7, 2026 11:03
@mintlify mintlify Bot mentioned this pull request Nov 7, 2026

This branch was successfully deployed

1 active deployment
staging — 15312a19 Deployed Nov 7, 2026 by mintlify[bot]
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.

1 participant