Skip to content
This repository was archived by the owner on Jul 7, 2025. It is now read-only.

Commit 98e9efd

Browse files
committed
#33 addresses comments from @mnot @reschke @royfielding, designated experts for the Hypertext Transfer Protocol (HTTP) Field Name Registry registry
1 parent 25738aa commit 98e9efd

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

draft-ietf-httpapi-deprecation-header.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
coding: utf-8
33
abbrev:
44
title: The Deprecation HTTP Header Field
5-
docname: draft-ietf-httpapi-deprecation-header-latest
5+
docname: draft-ietf-httpapi-deprecation-header-05
66
category: std
77

88
ipr: trust200902
@@ -36,6 +36,7 @@ normative:
3636
HTTP: RFC9110
3737
LINK: RFC8288
3838
STRUCTURED-FIELDS: I-D.ietf-httpbis-sfbis
39+
SUNSET: RFC8594
3940

4041

4142
informative:
@@ -73,9 +74,9 @@ The `Deprecation` HTTP response header field allows a server to communicate to a
7374

7475
## Syntax
7576

76-
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). `Deprecation` is an Item Structured Header {{!RFC8941}}. Refer to Section 3.3.7 of [STRUCTURED-FIELDS] for ABNF of `sf-date`:
77+
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). `Deprecation` is an Item Structured Header {{!RFC8941}}. Refer to Section 3.3.7 of [STRUCTURED-FIELDS] for `sf-date`:
7778

78-
~~~ abnf
79+
~~~
7980
Deprecation = sf-date
8081
~~~
8182

@@ -127,7 +128,7 @@ Given that the deprecation date is in the past, the linked information resource
127128

128129
# Sunset
129130

130-
In addition to the deprecation related information, if the resource provider wants to convey to the client application that the deprecated resource is expected to become unresponsive at a specific point in time, the Sunset HTTP header field {{?RFC8594}} can be used in addition to the `Deprecation` header field.
131+
In addition to the deprecation related information, if the resource provider wants to convey to the client application that the deprecated resource is expected to become unresponsive at a specific point in time, the Sunset HTTP header field [SUNSET] can be used in addition to the `Deprecation` header field.
131132

132133
The timestamp given in the `Sunset` header field MUST NOT be earlier than the one given in the `Deprecation` header field.
133134

@@ -148,7 +149,7 @@ The `Deprecation` response header field should be added to the "Hypertext Transf
148149

149150
Header Field Name: Deprecation
150151

151-
Applicable Protocol: Hypertext Transfer Protocol (HTTP)
152+
Protocol: Hypertext Transfer Protocol (HTTP)
152153

153154
Status: Standard
154155

@@ -166,26 +167,22 @@ The `Deprecation` response header field should be added to the "Hypertext Transf
166167

167168
The `deprecation` link relation type should be added to the permanent registry of link relation types ({{Section 4.2 of LINK}}).
168169

169-
Relation Type: deprecation
170+
Relation Name: deprecation
170171

171-
Applicable Protocol: Hypertext Transfer Protocol (HTTP)
172-
173-
Status: Standard
172+
Description: Identifies deprecation related documentation for the context that is primarily intended for human consumption.
174173

175174
Author: Sanjay Dalal <[email protected]>,
176175
Erik Wilde <[email protected]>
177176

178-
Change controller: IETF
179-
180177
Specification document: this specification,
181178
Section 3 "The Deprecation Link Relation Type"
182179

183180

184181
# Security Considerations
185182

186-
The Deprecation header field should be treated as a hint, meaning that the resource is indicating (and not guaranteeing with certainty) that it will be or is deprecated. Deprecated resources MUST function (almost) as before, even though one might consider non-functional details such as making them progressively less efficient with longer response time for example.
183+
The Deprecation header field should be treated as a hint, meaning that the resource is indicating (and not guaranteeing with certainty) that it will be or is deprecated. Deprecated resources MUST function (almost) as before, even though one might consider non-functional details such as making them progressively less efficient with longer response time for example.
187184

188-
Resource documentation SHOULD provide additional information about the deprecation, such as including recommendation(s) for replacement. Applications consuming the resource SHOULD check the referred resource documentation to verify authenticity and accuracy. In cases where a `Link` header field is used to provide documentation, one should assume (unless served over HTTPS) that the content of the `Link` header field may not be secure, private or integrity-guaranteed, and due caution should be exercised when using it. Also, in cases where the Deprecation header field value is a date in the future, it can lead to information that otherwise might not be available. Therefore, applications consuming the resource SHOULD, if possible, consult the resource developer to discuss potential impact due to deprecation and plan for possible transition to a recommended resource(s).
185+
Resource documentation SHOULD provide additional information about the deprecation, such as including recommendation(s) for replacement. Applications consuming the resource SHOULD check the referred resource documentation to verify authenticity and accuracy. In cases where a `Link` header field is used to provide documentation, one should assume (unless served over HTTPS) that the content of the `Link` header field may not be secure, private or integrity-guaranteed, and due caution should be exercised when using it. Also, in cases where the Deprecation header field value is a date in the future, it can lead to information that otherwise might not be available. Therefore, applications consuming the resource SHOULD, if possible, consult the resource developer to discuss potential impact due to deprecation and plan for possible transition to a recommended resource(s).
189186

190187

191188
--- back

0 commit comments

Comments
 (0)