Skip to content

[Docs] docs/pagination-contract.md is not referenced from OpenAPI descriptions on list endpoints #1516

Description

@grantfox-oss

Join our community: https://t.me/+DOylgFv1jyJlNzM0

Why this matters
docs/pagination-contract.md defines the pagination contract used across list endpoints, but the swagger annotations in backend/src/config/swaggerSchemas.ts don't link back to it, so API consumers reading the docs route have no pointer to the full contract.

Acceptance criteria

  • Add a link to docs/pagination-contract.md in the shared pagination response schema description in swaggerSchemas.ts
  • Verify it renders in the Swagger UI

Files to touch

  • backend/src/config/swaggerSchemas.ts
  • docs/pagination-contract.md

Out of scope
Changing the pagination contract itself.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackendIssues related to backend developmentdocsDocumentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions