Skip to content

fix: remove remaining title/$ref siblings and add missing titles#228

Merged
AaryamanBhute merged 2 commits intomainfrom
fix/remaining-title-fixes
Feb 25, 2026
Merged

fix: remove remaining title/$ref siblings and add missing titles#228
AaryamanBhute merged 2 commits intomainfrom
fix/remaining-title-fixes

Conversation

@pengying
Copy link
Contributor

Summary

  • Remove title: lines that were siblings to $ref: in ExternalAccountInfoOneOf.yaml (22 entries) — these are ignored per the OpenAPI spec and cause Mintlify to not display titles correctly
  • Remove the same title:/$ref: sibling pattern from CadExternalAccountInfo and NgnExternalAccountInfo beneficiary oneOf entries (added in feat: add NGN and CAD external account and beneficiary schemas #226)
  • Add missing title: Individual Beneficiary to CadBeneficiary.yaml and NgnBeneficiary.yaml so Mintlify renders the oneOf type selector properly

Test plan

  • make build passes
  • make lint passes (22 pre-existing warnings, 0 errors)
  • Verify Mintlify renders external account info oneOf type selector with correct labels
  • Verify beneficiary oneOf renders correctly for CAD and NGN accounts

🤖 Generated with Claude Code

- Remove title lines from ExternalAccountInfoOneOf.yaml oneOf entries
  (titles as $ref siblings are ignored per OpenAPI spec)
- Remove title/$ref siblings from CadExternalAccountInfo and
  NgnExternalAccountInfo beneficiary oneOf entries
- Add missing titles to CadBeneficiary.yaml and NgnBeneficiary.yaml

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Feb 25, 2026

✱ Stainless preview builds

This PR will update the grid SDKs with the following commit messages.

kotlin

chore(internal): regenerate SDK with no functional changes

openapi

chore(internal): move schema titles from oneOf refs to schema definitions

python

chore(internal): regenerate SDK with no functional changes

typescript

chore(internal): regenerate SDK with no functional changes
grid-openapi studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅

grid-python studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/28c77181733df6b022075bf9dca2a4be10bec40c/grid-0.0.1-py3-none-any.whl
grid-kotlin studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ✅lint ✅test ✅

grid-typescript studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ✅lint ✅test ✅

npm install https://pkg.stainless.com/s/grid-typescript/73ea33621a0fbe5140a254a555af59c526f3bb23/dist.tar.gz

This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-02-25 06:51:35 UTC

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 25, 2026

Greptile Summary

This PR fixes OpenAPI spec compliance issues that were preventing Mintlify from rendering discriminated union type selectors correctly. The changes remove title: properties that were placed as siblings to $ref: in oneOf entries (which are ignored per the OpenAPI spec) and instead add the missing titles directly inside the referenced schema files.

Changes made:

  • Removed 22 title:/$ref: sibling pairs from ExternalAccountInfoOneOf.yaml (one for each account type variant)
  • Removed title:/$ref: sibling pairs from CadExternalAccountInfo.yaml and NgnExternalAccountInfo.yaml beneficiary oneOf entries
  • Added title: Individual Beneficiary to CadBeneficiary.yaml and NgnBeneficiary.yaml to match the existing pattern used in UsdBeneficiary.yaml, BrlBeneficiary.yaml, and other beneficiary schemas
  • Added comprehensive documentation to openapi/README.md explaining the correct title placement pattern and discriminator location rules
  • Both bundled outputs (openapi.yaml and mintlify/openapi.yaml) correctly reflect these changes

This change ensures Mintlify can properly display type selector labels for external account info and beneficiary oneOf unions.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it only fixes OpenAPI metadata placement to comply with the spec
  • The changes are purely structural metadata corrections that align the OpenAPI spec with the standard. All titles are being moved from invalid locations (as siblings to $ref) to valid locations (inside the referenced schemas). The PR author verified that make build and make lint pass, and the bundled outputs correctly reflect all source changes. This is a documentation/metadata-only change with no impact on API behavior.
  • No files require special attention

Important Files Changed

Filename Overview
openapi/components/schemas/external_accounts/ExternalAccountInfoOneOf.yaml Removed 22 title/$ref siblings that were ignored by OpenAPI spec, properly relying on titles within referenced schemas
openapi/components/schemas/common/CadBeneficiary.yaml Added missing title: Individual Beneficiary to enable proper Mintlify oneOf rendering
openapi/components/schemas/common/NgnBeneficiary.yaml Added missing title: Individual Beneficiary to enable proper Mintlify oneOf rendering
openapi/components/schemas/external_accounts/CadExternalAccountInfo.yaml Removed title/$ref siblings from beneficiary oneOf, now properly relies on schema titles
openapi/components/schemas/external_accounts/NgnExternalAccountInfo.yaml Removed title/$ref siblings from beneficiary oneOf, now properly relies on schema titles
openapi/README.md Added comprehensive documentation on title placement and discriminator location best practices

Last reviewed commit: 8531eac

…ADME

Document two common pitfalls when defining oneOf schemas:
- Discriminators must only exist on the OneOf wrapper, not base schemas
- Titles must be inside referenced schema files, not as $ref siblings

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@AaryamanBhute AaryamanBhute merged commit 2b4d733 into main Feb 25, 2026
8 checks passed
@AaryamanBhute AaryamanBhute deleted the fix/remaining-title-fixes branch February 25, 2026 06:45
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.

2 participants