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

Commit 7357ff9

Browse files
committed
addresses most of the comments from #30
1 parent 2dbc510 commit 7357ff9

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

draft-ietf-httpapi-deprecation-header.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@ author:
3535
normative:
3636
HTTP: RFC9110
3737
LINK: RFC8288
38-
SFBIS:
38+
STRUCTURED-FIELDS:
3939
title: Structured Field Values for HTTP
40-
date: 2023-11-06
40+
date: 2024-01-23
4141
author:
4242
- ins: M. Nottingham
43-
- ins: P-H. Kamp
44-
target: https://datatracker.ietf.org/doc/draft-ietf-httpbis-sfbis/
43+
- ins: P. Kamp
44+
target: https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-sfbis-05
4545

4646
informative:
4747

4848

4949
--- abstract
5050

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.
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 document uses the terminology from Section 3 of [SFBIS] to specify syntax and parsing of Date.
71+
This document uses the terminology from Section 3 of [STRUCTURED-FIELDS] 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

@@ -78,14 +78,14 @@ The `Deprecation` HTTP response header field allows a server to communicate to a
7878

7979
## Syntax
8080

81-
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 [SFBIS] for ABNF of `sf-date`:
81+
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`:
8282

8383
~~~ abnf
8484
Deprecation = sf-date
8585
~~~
8686

8787

88-
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].
88+
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 [STRUCTURED-FIELDS].
8989

9090
The following example shows that the resource context has been deprecated on Friday, June 30, 2023 at 23:59:59 GMT:
9191

@@ -119,7 +119,7 @@ The purpose of the `Deprecation` header field is to provide a hint about depreca
119119
Link: <https://developer.example.com/deprecation>;
120120
rel="deprecation"; type="text/html"
121121

122-
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.
122+
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 describing how deprecation is managed for the resource. This may be the 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 take place.
123123

124124
The following example uses the same link header field, but also announces a deprecation date using a Deprecation header field:
125125

@@ -186,24 +186,17 @@ The `deprecation` link relation type should be added to the permanent registry o
186186
Section 3 "The Deprecation Link Relation Type"
187187

188188

189-
# Examples
189+
# Security Considerations
190190

191-
The following example does not show complete HTTP interaction. It only shows those HTTP header fields in a response that are relevant for resource deprecation.
192-
193-
Deprecation: @1688169599
194-
Link: <https://developer.example.com/deprecation>; rel="deprecation"
195-
196-
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.
191+
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. Resource documentation SHOULD provide additional information about the deprecation, potentially including recommendation(s) for replacement.
200192

201193
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.
202194

203195
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.
204196

205197
--- back
206198

199+
207200
# Implementation Status
208201

209202
Note to RFC Editor: Please remove this section before publication.
@@ -270,7 +263,7 @@ Organization: IBM
270263

271264
Organization: Ultipro
272265

273-
- Description: Ultipro uses the HTTP `Warning` header field as described in Section 5.5 of {{!RFC7234}} with code `299`
266+
- Description: Ultipro uses the HTTP `Warning` header field as described in Section 5.5 of {{!RFC9111}} with code `299`
274267
- Reference: https://connect.ultipro.com/api-deprecation
275268

276269
Organization: Clearbit
@@ -284,7 +277,7 @@ Organization: PayPal
284277
- Reference: https://github.com/paypal/api-standards/blob/master/api-style-guide.md#runtime
285278

286279

287-
# Changes from Draft-03 {#changes}
280+
# Changes from Draft-04 {#changes}
288281

289282
This revision has made the following changes:
290283

0 commit comments

Comments
 (0)