The Deprecation HTTP Header Field
draft-ietf-httpapi-deprecation-header-01
HTTPAPI S. Dalal
Internet-Draft
Intended status: Standards Track E. Wilde
Expires: 28 June 2021 25 December 2020
The Deprecation HTTP Header Field
draft-ietf-httpapi-deprecation-header-01
Abstract
The HTTP Deprecation Response Header Field can be used to signal to
consumers of a URI-identified resource that the resource has been
deprecated. Additionally, the deprecation link relation can be used
to link to a resource that provides additional context for the
deprecation, and possibly ways in which clients can find a
replacement for the deprecated resource.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 28 June 2021.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Dalal & Wilde Expires 28 June 2021 [Page 1]
Internet-Draft The Deprecation HTTP Header Field December 2020
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 3
2. The Deprecation HTTP Response Header . . . . . . . . . . . . 3
2.1. Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. The Deprecation Link Relation Type . . . . . . . . . . . . . 4
3.1. Documentation . . . . . . . . . . . . . . . . . . . . . . 4
4. Recommend Replacement . . . . . . . . . . . . . . . . . . . . 5
5. Sunset . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6. Resource Behavior . . . . . . . . . . . . . . . . . . . . . . 6
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
7.1. The Deprecation HTTP Response Header . . . . . . . . . . 6
7.2. The Deprecation Link Relation Type . . . . . . . . . . . 7
8. Implementation Status . . . . . . . . . . . . . . . . . . . . 7
8.1. Implementing the Deprecation Header . . . . . . . . . . . 8
8.2. Implementing the Concept . . . . . . . . . . . . . . . . 9
9. Security Considerations . . . . . . . . . . . . . . . . . . . 10
10. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 11
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 11
11.1. Normative References . . . . . . . . . . . . . . . . . . 11
11.2. Informative References . . . . . . . . . . . . . . . . . 12
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 13
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 13
1. Introduction
Deprecation of an HTTP resource as defined in Section 2 of [RFC7231]
is a technique to communicate information about the lifecycle of a
resource. It encourages applications to migrate away from the
resource, discourages applications from forming new dependencies on
the resource, and informs applications about the risk of continuing
dependence upon the resource.
The act of deprecation does not change any behavior of the resource.
It just informs client of the fact that a resource is deprecated.
The Deprecation HTTP response header field MAY be used to convey this
fact at runtime to clients. The header field can carry information
indicating since when the deprecation is in effect.
In addition to the Deprecation header field the resource provider can
use other header fields to convey additional information related to
deprecation. For example, information such as where to find
documentation related to the deprecation or what should be used as an
Show full document text