Skip to content

docs(sdks): document Go enableRequestBodyPagination option - #6652

Merged
devalog merged 3 commits into
mainfrom
devin/1786813681-go-request-body-pagination
Aug 17, 2026
Merged

docs(sdks): document Go enableRequestBodyPagination option#6652
devalog merged 3 commits into
mainfrom
devin/1786813681-go-request-body-pagination

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Go SDKs silently skipped auto-pagination when an endpoint's cursor or offset page property lives in the request body instead of a query parameter, so those APIs generated a plain single-response method and users had to hand-roll the paging loop. The Go generator now supports request-body cursor and offset pagination behind the new enableRequestBodyPagination option, bringing Go in line with the other languages. The option is off by default because turning it on changes affected methods' return types (from a response to a pager), keeping existing generated signatures stable until customers opt in.

Implements docs for: feat(go): opt-in auto-pagination for request body cursors and offsets (fern-api/fern#17352)

Pages changed

  • fern/products/sdks/generators/go/configuration.mdx — new enableRequestBodyPagination <ParamField> (boolean, default false) covering what it enables, why it is off by default, and that nested body page properties (cursor: $request.pagination.cursor) remain unsupported and still generate a plain method. Links to the auto-pagination deep dive.
  • fern/products/sdks/deep-dives/configure-auto-pagination.mdx — the "Generated SDK behavior" tabs only had TypeScript and Python, so a Go-only sentence had nowhere natural to live. Added Go, Java, and C# tabs, and folded the enableRequestBodyPagination requirement into the Go tab. Each snippet matches the pager API in the generated SDKs: *core.Page[T] with Iterator() / GetNextPage(ctx) (Go), SyncPagingIterable<T> with iteration, streamItems(), and nextPage() (Java), Pager<T> as an IAsyncEnumerable<T> consumed with await foreach (C#).

No SDK changelog entry added (generated automatically for the generators). Vale and fern check --warnings pass with no new findings.

Link to Devin session: https://app.devin.ai/sessions/fbc018f9c6694760843c05d716902c69

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

devalog and others added 2 commits August 17, 2026 16:52
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…avior

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devalog
devalog merged commit e119b06 into main Aug 17, 2026
4 checks passed
@devalog
devalog deleted the devin/1786813681-go-request-body-pagination branch August 17, 2026 17:01
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