Skip to content

Add API versioning strategy ahead of breaking changes #44

Description

@Mkalbani

Description

The API surface has grown quickly (search, analytics, ranking, moderation) with no versioning in place, meaning any future breaking change (e.g. the pagination migration) risks breaking existing consumers with no transition path. Introduce explicit versioning before more breaking changes land.

Acceptance Criteria

  • NestJS URI-based versioning (/v1/...) enabled at the application level
  • All existing routes namespaced under /v1 with redirects or aliases from the old unversioned paths for a deprecation period
  • A documented deprecation policy (e.g. minimum notice period) added to CONTRIBUTING.md or docs/
  • Swagger/OpenAPI docs (if present) reflect the versioned paths
  • CI includes a check that new breaking changes to /v1 routes are flagged in PR review (e.g. a checklist item or lint rule)

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third Campaign

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions