Skip to content

Add a deprecation header on legacy /v1 endpoints with sunset date #471

Description

@greatest0fallt1me

Description

This is a backend issue for the GrantFox campaign. Stamp Deprecation and Sunset headers on /v1 endpoints with the planned removal date.

Requirements and Context

  • Deprecation header on every /v1 response
  • Sunset header with ISO date
  • Logged warning on use
  • Sunset documented in CHANGELOG
  • Must be secure, tested, and documented
  • Should be efficient and easy to review

Suggested Execution

  1. Fork the repo and create a branch
    git checkout -b task/deprecation-headers
  2. Implement changes
    • src/middleware/deprecation.ts (new)
    • src/routes/index.ts
    • CHANGELOG.md
  3. Test and commit
    • Run the repo's standard test suite and lint
    • Cover edge cases; include output in the PR

Example commit message

feat: stamp Deprecation/Sunset headers on /v1

Acceptance Criteria

  • Headers present
  • Logged warning
  • CHANGELOG updated
  • Tests assert headers

Guidelines

  • Minimum 90% test coverage on changed lines
  • Input validation at the boundary; standardized error envelope
  • Structured logging with correlation IDs
  • Clear documentation and inline comments
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

Labels

GRANTFOX OSSGrantFox open-source campaign taskOFFICIAL CAMPAIGNOfficial GrantFox campaign issueStellar WaveIssues in the Stellar wave programapiAPI endpoint/contract workbackendBackend service workdocumentationDocumentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions