Deprecation

Info

Deprecation can take 2 forms: partial deprecation and version deprecation.

Partial deprecation is where an element such as a query param, a property, a header, or a complete endpoint is marked as deprecated. This warns consumers that this element may not be supported in future major releases of the API and guides them to use the better alternative.

Version deprecation is when the API team has replaced the API with a newer version, or the VA has decided to stop supporting the API.