Project

General

Profile

Actions

User story #6340

closed

Add a deprecation attribute in REST responses

Added by François ARMAND about 9 years ago. Updated about 4 years ago.

Status:
Resolved
Priority:
N/A
Assignee:
-
Category:
API
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

When an API is deprecated, it must be apparent in the response.

We need:
- an optionnal deprecation attribute in our JSON response, defaulted to false.
- an header. Internet does not seems to have a convention on it: http://stackoverflow.com/questions/12506817/http-header-field-for-uri-deprecation-expiration

For consistancy, both attribute should be the same (modulo case).

I propose to simply use: "deprecated".


Related issues 2 (1 open1 closed)

Related to Rudder - User story #6339: Advertise deprecation of REST API version 2 & 3RejectedFrançois ARMANDActions
Blocks Rudder - User story #6342: Add a warning in the client CLI when the deprecation attribute is presentNewActions
Actions

Also available in: Atom PDF