Vikranth Reddimasu Portfolio API Versioning and Deprecation Policy
This policy defines which API changes clients can accept safely and how much notice they receive before an operation is retired.
Current version
The current stable REST version is v1, exposed under /api/v1. Breaking changes require a new major path such as /api/v2. Existing response fields do not change meaning within a major version.
Compatible changes
A current major version may gain optional response fields, new endpoints, clearer descriptions, or additional documented error codes. Clients should ignore fields they do not recognize and use the typed schemas in the OpenAPI specification as the contract.
Deprecation and sunset
A deprecated operation is marked in the OpenAPI document and returns a Deprecation header plus a Link to migration guidance. When a retirement date is chosen, responses also include an HTTP Sunset header. The sunset date will be at least 180 days after the public deprecation notice. No current v1 operation is deprecated, so current endpoints do not emit those status headers.
Migration support
Migration guidance will identify the replacement operation, behavioral differences, and the last supported date. The compatibility alias /api/profile currently points clients to /api/v1/profile; new integrations should use the versioned path directly. See the developer portal for quickstarts and live endpoints.