Skip to content

fix(docs): preserve items response fields - #6587

Merged
j15z merged 1 commit into
stagingfrom
fix/docs-items-properties
Aug 12, 2026
Merged

fix(docs): preserve items response fields#6587
j15z merged 1 commit into
stagingfrom
fix/docs-items-properties

Conversation

@j15z

@j15z j15z commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • distinguish response fields named items from structural array item schemas
  • add regression coverage for inline and constant-backed output definitions
  • regenerate affected integration documentation

Type of Change

  • Bug fix

Testing

  • bunx vitest run scripts/generate-docs.test.ts
  • bun scripts/generate-docs.ts
  • bun run lint
  • block registry validation
  • all 25 repository audits

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 12, 2026 2:43am

Request Review

@cursor

cursor Bot commented Aug 12, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Docs-only bug fix in the generator and regenerated markdown. No runtime product behavior changes.

Overview
Fixes the docs generator so response fields named items are no longer dropped when they collide with JSON Schema array items keywords.

parsePropertiesContent and parseConstProperties now keep items as a real output field, and nested schema lookups use top-level matching when the field itself is named items. Adds regression tests and regenerates affected integration docs (Gong, Google Forms, 1Password, SAP Concur, SharePoint, Stripe) so those fields appear in the output tables.

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

@greptile-apps

greptile-apps Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR fixes documentation schema parsing so response properties named items are preserved without being confused with structural array-item schemas.

  • Adds depth-aware matching for structural properties and items keywords.
  • Adds regression coverage for inline, constant-backed, and constant-property output definitions.
  • Regenerates affected integration documentation to include previously omitted response fields.

Confidence Score: 5/5

The PR appears safe to merge with no actionable defects identified.

The parser now distinguishes response fields named items from structural schema keywords, and the added regression cases cover the changed inline and constant-resolution paths.

Important Files Changed

Filename Overview
scripts/generate-docs.ts Preserves legitimate items response properties while restricting structural schema-keyword matching to the appropriate nesting depth.
scripts/generate-docs.test.ts Adds focused regression tests covering nested, direct-constant, constant-property, and constant-defined items fields.
apps/docs/content/docs/en/integrations/stripe.mdx Regenerates subscription response documentation with the previously omitted subscription-items object and descendants.
apps/docs/content/docs/en/integrations/gong.mdx Restores omitted items fields and nested highlight-item details.
apps/docs/content/docs/en/integrations/google_forms.mdx Restores the form response’s items collection and documented item variants.
apps/docs/content/docs/en/integrations/onepassword.mdx Restores the numeric vault item-count response field.
apps/docs/content/docs/en/integrations/sap_concur.mdx Restores allocation and budget collection items fields in generated documentation.
apps/docs/content/docs/en/integrations/sharepoint.mdx Restores nested SharePoint list-item response documentation.

Reviews (1): Last reviewed commit: "fix(docs): preserve items response field..." | Re-trigger Greptile

@j15z
j15z merged commit a72457b into staging Aug 12, 2026
30 checks passed
@j15z
j15z deleted the fix/docs-items-properties branch August 12, 2026 02:44
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