You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: draft-ietf-httpapi-deprecation-header.md
+4-13Lines changed: 4 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,29 +109,20 @@ This specification places no restrictions on the representation of the linked de
109
109
110
110
## Documentation
111
111
112
-
Deprecation of a resource could involve portions of requests to it, responses from it, or both. These could be comprised from one or more of the following:
113
-
114
-
* URI - deprecation of one or more query parameter(s) or path element(s)
115
-
* method - HTTP method for the resource is deprecated
116
-
* request header - one or more HTTP request header(s) is deprecated
117
-
* response header - HTTP response header(s) is deprecated
118
-
* request body - request body contains one or more deprecated element(s)
119
-
* response body - response body contains one or more deprecated element(s)
120
-
121
-
The purpose of the `Deprecation` header is to provide just enough "hints" about the deprecation to the client application developer. It is safe to assume that on reception of the `Deprecation` header, the client developer would look up the resource's documentation in order to find deprecation related semantics. The resource developer could provide a link to the resource documentation using a `Link` header with relation type `deprecation` as shown below.
112
+
The purpose of the `Deprecation` header is to provide a hint about deprecation to the resource consumer. Upon reception of the `Deprecation` header, the client developer can look up the resource's documentation in order to find deprecation related information. The resource provider can provide a link to the resource documentation using a `Link` header with relation type `deprecation` as shown below:
In this example the linked content provides additional information about the deprecation of the resource context. There is no Deprecation header field in the response, and thus the resource is not deprecated. However, the resource already exposes a link where information is available how deprecation is managed for the context. This may be documentation explaining the use of the Deprecation header field, and also explaining under which circumstances and with which policies (announcement before deprecation; continued operation after deprecation) deprecation might be happening.
117
+
In this example the linked content provides additional information about deprecation of the resource context. There is no Deprecation header field in the response, and thus the resource is not (yet) deprecated. However, the resource already exposes a link where information is available how deprecation is managed for the resource context. This may be documentation explaining the use of the Deprecation header field, and also explaining under which circumstances and with which policies (announcement before deprecation; continued operation after deprecation) deprecation might be happening.
127
118
128
-
The following example uses the same link header, but also announces a deprecation date using a Deprecation header field.
119
+
The following example uses the same link header, but also announces a deprecation date using a Deprecation header field:
Given that the deprecation date is in the past, the linked resource may have been updated to include information about the deprecation, allowing clients to discover information about the deprecation that happened.
125
+
Given that the deprecation date is in the past, the linked information resource may have been updated to include information about the deprecation, allowing consumers to discover information about the deprecation and how to best manage it.
0 commit comments