builder icon indicating copy to clipboard operation
builder copied to clipboard

Documentation - Content API section does not talk about how to get all pages.

Open georgesunnytHDS opened this issue 9 months ago • 1 comments

The documentation for content api does not talk about how to get all the content for a particular data model. For example, on this page https://www.builder.io/c/docs/content-api#code-limit-code , the example given by builder suggests that it would fetch all the entries for 'my-mode-name' with the limit 10.

import { builder } from "@builder.io/react";

// replace model with your model name
const entries = await builder.getAll('my-model-name', {
  limit: 10
})

But this would only get all the entries for that model if options: { noTargeting: true }, is included like this below,

import { builder } from "@builder.io/react";

// replace model with your model name
const entries = await builder.getAll('my-model-name', {
  options: { noTargeting: true },
  limit: 10
})

Nothing in this page https://www.builder.io/c/docs/content-api talks about options: { noTargeting: true }. I think it would be critical to add documentation regarding this to the page to save developer time and avoid confusion.

I also noticed that this was brought up once 4 years ago https://forum.builder.io/t/why-does-builder-getall-not-return-all-results/419 when another developer had the same confusion.

georgesunnytHDS avatar Apr 02 '25 12:04 georgesunnytHDS

this is great feedback @georgesunnytHDS - thanks for sharing. i've forwarded this to our docs team

steve8708 avatar Apr 02 '25 15:04 steve8708