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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ The Deprecation HTTP response header field is used to signal to consumers of a U
51
51
52
52
# Introduction
53
53
54
-
Deprecation of an HTTP resource ({{Section 2 of HTTP}}) communicates information about the lifecycle of a resource. It encourages applications to migrate away from the resource, discourages applications from forming new dependencies on the resource, and informs applications about the risk of continued dependence upon the resource.
54
+
Deprecation of an HTTP resource ({{Section 3.1 of HTTP}}) communicates information about the lifecycle of a resource. It encourages applications to migrate away from the resource, discourages applications from forming new dependencies on the resource, and informs applications about the risk of continued dependence upon the resource.
55
55
56
56
The act of deprecation does not change any behavior of the resource. It informs clients of the fact that a resource will be or is deprecated. The Deprecation HTTP response header field can be used to convey this at runtime to clients and carries information indicating when the deprecation will be in effect.
57
57
@@ -62,17 +62,17 @@ In addition to the Deprecation header field, the resource provider can use other
62
62
63
63
{::boilerplate bcp14-tagged}
64
64
65
-
This specification uses the Augmented Backus-Naur Form (ABNF) notation of {{!RFC5234}} and includes, by reference, the IMF-fixdate rule as defined in {{Section 7.1.1.1 of HTTP}}.
65
+
This specification uses the Augmented Backus-Naur Form (ABNF) notation of {{!RFC5234}} and includes, by reference, the IMF-fixdate rule as defined in {{Section 5.6.7 of HTTP}}.
66
66
67
-
The term "resource" is to be interpreted as defined in {{Section 2 of HTTP}}.
67
+
The term "resource" is to be interpreted as defined in {{Section 3.1 of HTTP}}.
68
68
69
69
# The Deprecation HTTP Response Header Field
70
70
71
71
The `Deprecation` HTTP response header field allows a server to communicate to a client that the resource in context of the message is or will be deprecated.
72
72
73
73
## Syntax
74
74
75
-
The `Deprecation` response header field describes the deprecation of the resource identified with the response it occurred within (see {{Section 3.1.4.1 of HTTP}}). It conveys the deprecation date, which may be in the future (the resource context will be deprecated at that date) or in the past (the resource context has been deprecated at that date).
75
+
The `Deprecation` response header field describes the deprecation of the resource identified with the response it occurred within (see {{Section 6.4.2 of HTTP}}). It conveys the deprecation date, which may be in the future (the resource context will be deprecated at that date) or in the past (the resource context has been deprecated at that date).
76
76
77
77
~~~ abnf
78
78
Deprecation = IMF-fixdate
@@ -91,7 +91,7 @@ The deprecation date can be in the future. This means that the resource will be
91
91
92
92
## Scope
93
93
94
-
The Deprecation header field applies to the resource identified with the response it occurred within (see {{Section 3.1.4.1 of HTTP}}), meaning that it announces the upcoming deprecation of that specific resource. However, there may be scenarios where the scope of the announced deprecation is larger than just the single resource where it appears.
94
+
The Deprecation header field applies to the resource identified with the response it occurred within (see {{Section 6.4.2 of HTTP}}), meaning that it announces the upcoming deprecation of that specific resource. However, there may be scenarios where the scope of the announced deprecation is larger than just the single resource where it appears.
95
95
96
96
Resources are free to define such an increased scope, and usually this scope will be documented by the resource so that consumers of the resource know about the increased scope and can behave accordingly. When doing so, it is important to take into account that such increased scoping is invisible for consumers who are unaware of the increased scoping rules. This means that these consumers will not be aware of the increased scope, and they will not interpret deprecation information different from its standard meaning (i.e., it applies to the resource only).
0 commit comments