Project

General

Profile

Actions
Copy link

User story #6340

closed

Add a deprecation attribute in REST responses

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

Status:
Resolved
Priority:
N/A
Assignee:
-
Category:
API
Target version:
Ideas (not version specific)
Pull Request:
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 open — 1 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
Copy link
 #1

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 3.0.2 to 3.0.3
Actions
Copy link
 #2

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 3.0.3 to 3.0.4
Actions
Copy link
 #3

Updated by Benoît PECCATTE about 9 years ago

  • Tracker changed from Enhancement to User story
Actions
Copy link
 #4

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 3.0.4 to 3.0.5
Actions
Copy link
 #5

Updated by Vincent MEMBRÉ almost 9 years ago

  • Target version changed from 3.0.5 to 3.0.6
Actions
Copy link
 #6

Updated by Vincent MEMBRÉ almost 9 years ago

  • Target version changed from 3.0.6 to 3.0.7
Actions
Copy link
 #7

Updated by Vincent MEMBRÉ almost 9 years ago

  • Target version changed from 3.0.7 to 3.0.8
Actions
Copy link
 #8

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 3.0.8 to 3.0.9
Actions
Copy link
 #9

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 3.0.9 to 3.0.10
Actions
Copy link
 #10

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 3.0.10 to 3.0.11
Actions
Copy link
 #11

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 3.0.11 to 3.0.12
Actions
Copy link
 #12

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 3.0.12 to 3.0.13
Actions
Copy link
 #13

Updated by Vincent MEMBRÉ about 8 years ago

  • Target version changed from 3.0.13 to 3.0.14
Actions
Copy link
 #14

Updated by Vincent MEMBRÉ about 8 years ago

  • Target version changed from 3.0.14 to 3.0.15
Actions
Copy link
 #15

Updated by Vincent MEMBRÉ about 8 years ago

  • Target version changed from 3.0.15 to 3.0.16
Actions
Copy link
 #16

Updated by Vincent MEMBRÉ almost 8 years ago

  • Target version changed from 3.0.16 to 3.0.17
Actions
Copy link
 #17

Updated by Vincent MEMBRÉ almost 8 years ago

  • Target version changed from 3.0.17 to 302
Actions
Copy link
 #18

Updated by Alexis Mousset almost 8 years ago

  • Target version changed from 302 to 3.1.12
Actions
Copy link
 #19

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.12 to 3.1.13
Actions
Copy link
 #20

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.13 to 3.1.14
Actions
Copy link
 #21

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.14 to 3.1.15
Actions
Copy link
 #22

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.15 to 3.1.16
Actions
Copy link
 #23

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.16 to 3.1.17
Actions
Copy link
 #24

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.17 to 3.1.18
Actions
Copy link
 #25

Updated by Vincent MEMBRÉ about 7 years ago

  • Target version changed from 3.1.18 to 3.1.19
Actions
Copy link
 #26

Updated by Vincent MEMBRÉ about 7 years ago

  • Target version changed from 3.1.19 to 3.1.20
Actions
Copy link
 #27

Updated by Vincent MEMBRÉ almost 7 years ago

  • Target version changed from 3.1.20 to 3.1.21
Actions
Copy link
 #28

Updated by Vincent MEMBRÉ almost 7 years ago

  • Target version changed from 3.1.21 to 3.1.22
Actions
Copy link
 #29

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 3.1.22 to 3.1.23
Actions
Copy link
 #30

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 3.1.23 to 3.1.24
Actions
Copy link
 #31

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 3.1.24 to 3.1.25
Actions
Copy link
 #32

Updated by Benoît PECCATTE over 6 years ago

  • Target version changed from 3.1.25 to 4.1.9
Actions
Copy link
 #33

Updated by Vincent MEMBRÉ over 6 years ago

  • Target version changed from 4.1.9 to 4.1.10
Actions
Copy link
 #34

Updated by François ARMAND about 6 years ago

  • Assignee deleted (François ARMAND)
  • Target version changed from 4.1.10 to Ideas (not version specific)
  • Parent task deleted (#6339)
Actions
Copy link
 #35

Updated by François ARMAND about 6 years ago

  • Related to User story #6339: Advertise deprecation of REST API version 2 & 3 added
Actions
Copy link
 #36

Updated by François ARMAND about 6 years ago

  • Related to User story #6342: Add a warning in the client CLI when the deprecation attribute is present added
Actions
Copy link
 #37

Updated by François ARMAND about 6 years ago

  • Related to deleted (User story #6342: Add a warning in the client CLI when the deprecation attribute is present)
Actions
Copy link
 #38

Updated by François ARMAND about 6 years ago

  • Blocks User story #6342: Add a warning in the client CLI when the deprecation attribute is present added
Actions
Copy link
 #39

Updated by François ARMAND almost 4 years ago

  • Status changed from New to Resolved

We now have that, and we even have an api /api/latest/info that tells what version are supported, what endpoints are defined on each, etc.

Actions
Copy link

Also available in: Atom PDF