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

Commit 774cc93

Browse files
committed
Draft 04. Addresses some of MarkN's comments #29
1 parent ddfe4ac commit 774cc93

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

draft-ietf-httpapi-deprecation-header.md

Lines changed: 14 additions & 14 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-04
66
category: std
77

88
ipr: trust200902
@@ -48,7 +48,7 @@ informative:
4848

4949
--- abstract
5050

51-
The Deprecation HTTP response header field is used to signal to consumers of a URI-identified resource that the resource will be or has been deprecated. Additionally, the deprecation link relation can be used to link to a resource that provides additional information about planned or existing deprecation, and possibly ways in which clients can best manage deprecation.
51+
The Deprecation HTTP response header field is used to signal to consumers of a resource (in the sense of [URI]) that the resource will be or has been deprecated. Additionally, the deprecation link relation can be used to link to a resource that provides additional information about planned or existing deprecation, and possibly ways in which clients can best manage deprecation.
5252

5353

5454
--- middle
@@ -68,7 +68,7 @@ In addition to the Deprecation header field, the resource provider can use other
6868

6969
{::boilerplate bcp14-tagged}
7070

71-
This specification uses the Augmented Backus-Naur Form (ABNF) notation of {{!RFC5234}} and includes, by reference, the sf-date format as defined in [SFBIS].
71+
This document uses the terminology from Section 3 of [SFBIS] to specify syntax and parsing of Date.
7272

7373
The term "resource" is to be interpreted as defined in {{Section 3.1 of HTTP}}.
7474

@@ -85,8 +85,6 @@ Deprecation = sf-date
8585
~~~
8686

8787

88-
Servers MUST NOT include more than one `Deprecation` header field in the same response.
89-
9088
The date is the date when the resource was or will be deprecated. It is in the form of an Structured Field Date as defined in Section 3.3.7 of [SFBIS].
9189

9290
The following example shows that the resource context has been deprecated on Friday, June 30, 2023 at 23:59:59 GMT:
@@ -131,14 +129,6 @@ The following example uses the same link header field, but also announces a depr
131129

132130
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.
133131

134-
### Security Considerations
135-
136-
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. Applications consuming the resource SHOULD check the resource documentation to verify authenticity and accuracy. Resource documentation SHOULD provide additional information about the deprecation, potentially including recommendation(s) for replacement.
137-
138-
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 verify the resource documentation and if possible, consult the resource developer to discuss potential impact due to deprecation and plan for possible transition to recommended resource.
139-
140-
In cases where a `Link` header field is used to provide documentation, one should assume 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. Applications consuming the resource SHOULD check the referred resource documentation to verify authenticity and accuracy.
141-
142132

143133
# Sunset
144134

@@ -204,6 +194,14 @@ The following example does not show complete HTTP interaction. It only shows tho
204194
Link: <https://developer.example.com/deprecation>; rel="deprecation"
205195

206196

197+
### Security Considerations
198+
199+
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. Applications consuming the resource SHOULD check the resource documentation to verify authenticity and accuracy. Resource documentation SHOULD provide additional information about the deprecation, potentially including recommendation(s) for replacement.
200+
201+
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 verify the resource documentation and if possible, consult the resource developer to discuss potential impact due to deprecation and plan for possible transition to recommended resource.
202+
203+
In cases where a `Link` header field is used to provide documentation, one should assume 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. Applications consuming the resource SHOULD check the referred resource documentation to verify authenticity and accuracy.
204+
207205
--- back
208206

209207
# Implementation Status
@@ -290,7 +288,9 @@ Organization: PayPal
290288

291289
This revision has made the following changes:
292290

293-
* Date format is changed from IMF-fixdate rule as defined in {{Section 5.6.7 of HTTP}} to Structured Field for Date as defined in Section 3.3.7 of [SFBIS].
291+
* Changed 'URI-identified resource' to 'resource (in the sense of [URI])'
292+
* Uses Notational Conventions for Structured Fields as suggested in HTTP Editorial Style Guide
293+
* Security Considerations moved below the IANA Considerations
294294

295295
# Acknowledgments
296296

0 commit comments

Comments
 (0)