Skip to content

API versioning and deprecation policy #588

Description

@codebestia

Write docs/api-versioning.md. The backend serves unversioned REST routes and socket events consumed by a client that updates independently, and the codebase has already made breaking changes (removing sequenceNumber, moving the key-bundle route, requiring device on verify) with no written compatibility policy.

Acceptance criteria:

  • States the current position honestly — routes are unversioned today — and defines the intended policy going forward
  • Defines what counts as a breaking change for REST responses, socket event payloads and database-backed shapes
  • Gives the deprecation procedure: how a field or event is marked, how long it is supported, and how clients are notified
  • Documents the capability-negotiation mechanism as the existing precedent for shipping a protocol change without breaking older clients

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions