feat: expand nested properties for array-of-object fields in the API ref#1247
Merged
Conversation
Teach the Mintlify object-page codegen to populate a field's children from an array's itemProperties when the list items are objects (for example, time_pairs), so the generated API reference shows an Expandable with the inner properties (display_name, start_time, end_time) instead of just the array field. Mirrors the existing object-children handling. The regenerated API reference output is produced by the Generate CI job. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Ts8QgybjiqTo8AUpsuSvb
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
3 participants
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
Teaches the Mintlify object-page codegen to expand the inner properties of an array-of-objects field in the generated API reference. Previously such a field (for example,
time_pairson the time frame option object) rendered only the array field and its description; now it renders an<Expandable>with the item's properties (e.g.display_name,start_time,end_time), matching how object fields already render.Change
mintlify-codegen/lib/layout/object-page.ts—buildFieldnow populateschildrenfrom a list'sitemPropertieswhenitemFormat === 'object'(in addition to the existingformat === 'object'case). Mirrors the existing object-children handling and the legacy renderer'sitemPropertieslogic.mintlify-docs/api/**) is produced and committed by the Generate CI job.Notes / heads-up
time_pairs, so the CI-generated API-ref diff will be large. This is the intended general fix.@seamapi/*deps need GitHub Packages auth); CI is the authoritative generator, so the rendered output should be reviewed once the Generate job runs.🤖 Generated with Claude Code
https://claude.ai/code/session_018Ts8QgybjiqTo8AUpsuSvb
Generated by Claude Code