rfc9745v3.txt | rfc9745.txt | |||
---|---|---|---|---|
Internet Engineering Task Force (IETF) S. Dalal | Internet Engineering Task Force (IETF) S. Dalal | |||
Request for Comments: 9745 | Request for Comments: 9745 | |||
Category: Standards Track E. Wilde | Category: Standards Track E. Wilde | |||
ISSN: 2070-1721 March 2025 | ISSN: 2070-1721 March 2025 | |||
The Deprecation HTTP Header Field | The Deprecation HTTP Response Header Field | |||
Abstract | Abstract | |||
The Deprecation HTTP response header field is used to signal to | The Deprecation HTTP response header field is used to signal to | |||
consumers of a resource (in the sense of URI) that the resource will | consumers of a resource (in the sense of URI) that the resource will | |||
be or has been deprecated. Additionally, the deprecation link | be or has been deprecated. Additionally, the deprecation link | |||
relation can be used to link to a resource that provides further | relation can be used to link to a resource that provides further | |||
information about planned or existing deprecation. It may also | information about planned or existing deprecation. It may also | |||
provide ways in which client application developers can best manage | provide ways in which client application developers can best manage | |||
deprecation. | deprecation. | |||
skipping to change at line 166 ¶ | skipping to change at line 166 ¶ | |||
its resources but only on designated resources such as the API's home | its resources but only on designated resources such as the API's home | |||
document. This means that deprecation-related information is | document. This means that deprecation-related information is | |||
available, but in order to get it, client application developers have | available, but in order to get it, client application developers have | |||
to periodically inspect the home document. In this example, the | to periodically inspect the home document. In this example, the | |||
extended context of the Deprecation header field would be all | extended context of the Deprecation header field would be all | |||
resources provided by the API, while the visibility of the | resources provided by the API, while the visibility of the | |||
information would only be on the home document. | information would only be on the home document. | |||
3. The Deprecation Link Relation Type | 3. The Deprecation Link Relation Type | |||
In addition to the Deprecation HTTP header field, the server can use | In addition to the Deprecation HTTP response header field, the server | |||
links with the deprecation link relation type to communicate to the | can use links with the deprecation link relation type to communicate | |||
client application developer where to find more information about | to the client application developer where to find more information | |||
deprecation of the context. This can happen before the actual | about deprecation of the context. This can happen before the actual | |||
deprecation to make a deprecation policy discoverable or after | deprecation to make a deprecation policy discoverable or after | |||
deprecation when there may be documentation about the deprecation and | deprecation when there may be documentation about the deprecation and | |||
how to manage it. | how to manage it. | |||
This specification places no restrictions on the representation of | This specification places no restrictions on the representation of | |||
the linked deprecation policy. In particular, the deprecation policy | the linked deprecation policy. In particular, the deprecation policy | |||
may be available as human-readable documentation or as a machine- | may be available as human-readable documentation or as a machine- | |||
readable description. | readable description. | |||
3.1. Documentation | 3.1. Documentation | |||
skipping to change at line 270 ¶ | skipping to change at line 270 ¶ | |||
The Deprecation HTTP response header field has been added to the | The Deprecation HTTP response header field has been added to the | |||
"Hypertext Transfer Protocol (HTTP) Field Name Registry" | "Hypertext Transfer Protocol (HTTP) Field Name Registry" | |||
(Section 16.3.1 of [HTTP]) as follows: | (Section 16.3.1 of [HTTP]) as follows: | |||
Field Name: Deprecation | Field Name: Deprecation | |||
Status: permanent | Status: permanent | |||
Structured Type: Item | Structured Type: Item | |||
Reference: RFC 9745, Section 2: The Deprecation HTTP Header Field | Reference: RFC 9745, Section 2: The Deprecation HTTP Response Header | |||
Field | ||||
6.2. The Deprecation Link Relation Type | 6.2. The Deprecation Link Relation Type | |||
The deprecation link relation type has been added to the "Link | The deprecation link relation type has been added to the "Link | |||
Relation Types" registry (Section 4.2 of [LINK]) as follows: | Relation Types" registry (Section 4.2 of [LINK]) as follows: | |||
Relation Name: deprecation | Relation Name: deprecation | |||
Description: Refers to documentation (intended for human | Description: Refers to documentation (intended for human | |||
consumption) about the deprecation of the link's context. | consumption) about the deprecation of the link's context. | |||
End of changes. 3 change blocks. | ||||
6 lines changed or deleted | 7 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. |