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

Commit bdd4276

Browse files
authored
Merge pull request #27 from sdatspun2/main
uses sf-date
2 parents 4d11cc3 + d9ea359 commit bdd4276

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

draft-ietf-httpapi-deprecation-header.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,13 @@ author:
3535
normative:
3636
HTTP: RFC9110
3737
LINK: RFC8288
38-
38+
SFBIS:
39+
title: Structured Field Values for HTTP
40+
date: 2023-11-06
41+
author:
42+
- ins: M. Nottingham
43+
- ins: P-H. Kamp
44+
target: https://datatracker.ietf.org/doc/draft-ietf-httpbis-sfbis/
3945

4046
informative:
4147

@@ -62,7 +68,7 @@ In addition to the Deprecation header field, the resource provider can use other
6268

6369
{::boilerplate bcp14-tagged}
6470

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}}.
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].
6672

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

@@ -72,19 +78,20 @@ The `Deprecation` HTTP response header field allows a server to communicate to a
7278

7379
## Syntax
7480

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).
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`:
7682

7783
~~~ abnf
78-
Deprecation = IMF-fixdate
84+
Deprecation = sf-date
7985
~~~
8086

87+
8188
Servers MUST NOT include more than one `Deprecation` header field in the same response.
8289

83-
The date is the date when the resource was or will be deprecated. It is in the form of an IMF-fixdate timestamp.
90+
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].
8491

85-
The following example shows that the resource context has been deprecated on Sunday, November 11, 2018 at 23:59:59 GMT:
92+
The following example shows that the resource context has been deprecated on Friday, June 30, 2023 at 23:59:59 GMT:
8693

87-
Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
94+
Deprecation: @1688169599
8895

8996
The deprecation date can be in the future. This means that the resource will be deprecated at the indicated date in the future.
9097

@@ -118,7 +125,7 @@ In this example the linked content provides additional information about depreca
118125

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

121-
Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
128+
Deprecation: @1688169599
122129
Link: <https://developer.example.com/deprecation>;
123130
rel="deprecation"; type="text/html"
124131

@@ -131,10 +138,10 @@ In addition to the deprecation related information, if the resource provider wan
131138

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

134-
The following example shows that the resource in context has been deprecated since Sunday, November 11, 2018 at 23:59:59 GMT and its sunset date is Wednesday, November 11, 2020 at 23:59:59 GMT.
141+
The following example shows that the resource in context has been deprecated since Friday, June 30, 2023 at 23:59:59 GMT and its sunset date is Sunday, June 30, 2024 at 23:59:59 GMT. Please note that for historical reasons the Sunset HTTP header field uses a different data type for date.
135142

136-
Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
137-
Sunset: Wed, 11 Nov 2020 23:59:59 GMT
143+
Deprecation: @1688169599
144+
Sunset: Sun, 30 Jun 2024 23:59:59 GMT
138145

139146
# Resource Behavior
140147

@@ -277,18 +284,23 @@ The following examples do not show complete HTTP interactions. They only show th
277284

278285
The first example shows a deprecation header field with date information:
279286

280-
Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
287+
Deprecation: @1688169599
281288

282289
The second example shows a deprecation header field with a link for the resource's deprecation policy. In addition, it shows the sunset date for the deprecated resource:
283290

284-
Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
285-
Sunset: Wed, 11 Nov 2020 23:59:59 GMT
291+
Deprecation: @1688169599
292+
Sunset: Sun, 30 Jun 2024 23:59:59 GMT
286293
Link: <https://developer.example.com/deprecation>; rel="deprecation"
287294

288295

289296

290297
--- back
291298

299+
# Changes from Draft-03 {#changes}
300+
301+
This revision has made the following changes:
302+
303+
* 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].
292304

293305
# Acknowledgments
294306

0 commit comments

Comments
 (0)