Skip to content

Conversation

@davilima6
Copy link

@davilima6 davilima6 commented Nov 24, 2025

Purpose

Add support for enrichOptions parameter to the Content API, allowing users to control the depth level of reference enrichment when fetching content.

Approach and changes

  • added enrichOptions property with enrichLevel and model support to GetContentOptions type
  • implemented enrichOptions query parameter handling for /query and /content endpoints

Testing instructions

  1. Create a @builder.io/sdk test script
  2. Run getAll() method with enrichOptions:
    await builder.getAll('some-model-with-nested-references', {
      noTraverse: false,
      enrich: true,
      enrichOptions: {
        enrichLevel: 3,
        model: {
          'model1': {
            fields: 'id,data.field1,data.field3',
          },
          'model2': {
            fields:
              'data.id,data.field1,data.field2,data.field6',
          },
          'model3': {
            fields: 'data.and,so,on'
          },
        },
      },
      fields: 'data.rootField1,data.rootField2,data.rootField3',
      limit: 100,
      query: {
        'data.field': 'some value',
      },
    })
    
  3. Confirm the underlying API call includes enrich=true, enrichOptions.enrichLevel=3 and enrichOptions.model.model1=id,data.field1,data.field3 query parameters

@changeset-bot
Copy link

changeset-bot bot commented Nov 24, 2025

⚠️ No Changeset found

Latest commit: 337dc87

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@davilima6 davilima6 force-pushed the fix/enrichOptions-with-tests branch from e7ed2f9 to d517584 Compare November 24, 2025 08:59
@davilima6 davilima6 force-pushed the fix/enrichOptions-with-tests branch from d517584 to a2fdb06 Compare November 24, 2025 09:05
@chris-budd chris-budd requested a review from teleaziz December 1, 2025 14:21
@sanyamkamat sanyamkamat requested review from sanyamkamat and removed request for teleaziz December 1, 2025 17:50
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