Skip to content

feat(API): add page/per_page params to repo_syncs list endpoint #STRINGS-3518 - #1297

Merged
Sven Dunemann (forelabs) merged 1 commit into
mainfrom
agent/STRINGS-3518-dbb62f
Sep 24, 2026
Merged

Sven Dunemann (forelabs) merged 1 commit into
mainfrom
agent/STRINGS-3518-dbb62f

Conversation

@junior-ai-bot

@junior-ai-bot junior-ai-bot Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • GET /accounts/{account_id}/repo_syncs is paginated server-side via Kaminari (default_per_page = 25 in strings-app), returning its true total via a Pagination response header plus a standard Link: rel="next" header — both already declared in this endpoint's spec.
  • However, the request-side parameters list in paths/repo_syncs/index.yaml only documented X-PhraseApp-OTP and account_id, omitting the reusable page/per_page $refs already used by 50+ other list endpoints (e.g. paths/accounts/index.yaml, paths/accounts/locales.yaml, paths/authorizations/index.yaml).
  • This left API consumers (human or LLM agent) with no signal from the spec itself that the endpoint returns only a page of results, which was the proximate trigger for an Atlas agent session under-reporting an account's Repo Sync count.
  • Added $ref: parameters.yaml#/page and $ref: parameters.yaml#/per_page to paths/repo_syncs/index.yaml, consistent with sibling paginated list endpoints, and regenerated doc/compiled.json to reflect the new parameters.

Test plan

  • npx swagger-cli validate main.yaml — passes
  • npx swagger-cli bundle -t json -w 300 main.yaml > doc/compiled.json — regenerated, diff only adds the two new parameter refs to the repo_syncs list operation
  • bash ./lint.sh (via openapi-generator-cli validate against the bundled spec) — no validation errors

STRINGS-3518

🤖 Generated with Claude Code

GET /accounts/{account_id}/repo_syncs is paginated server-side via
Kaminari (default_per_page = 25), but the spec's parameters list was
missing the reusable page/per_page $refs already used by 50+ other
list endpoints, even though the Link and Pagination response headers
were already declared. Consumers of the spec had no signal that this
endpoint returns only a page of results.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

2 changes: 0 error, 0 warning, 2 info
info	[new-optional-request-parameter] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs
		added the new optional `query` request parameter `page`

info	[new-optional-request-parameter] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs
		added the new optional `query` request parameter `per_page`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant