The Deprecation HTTP Header
draft-dalal-deprecation-header-00

Document Type Active Internet-Draft (individual)
Last updated 2019-02-27
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                           S. Dalal
Internet-Draft
Intended status: Standards Track                                E. Wilde
Expires: August 30, 2019                               February 26, 2019

                      The Deprecation HTTP Header
                   draft-dalal-deprecation-header-00

Abstract

   The HTTP Deprecation response header can be used to signal to
   consumers of a URI-identified resource that the use of 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 August 30, 2019.

Copyright Notice

   Copyright (c) 2019 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

Dalal & Wilde            Expires August 30, 2019                [Page 1]
Internet-Draft         The Deprecation HTTP Header         February 2019

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   3
   2.  The Deprecation HTTP Response Header Field  . . . . . . . . .   3
     2.1.  Syntax  . . . . . . . . . . . . . . . . . . . . . . . . .   3
       2.1.1.  Version . . . . . . . . . . . . . . . . . . . . . . .   4
       2.1.2.  Date  . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  The Deprecation Link Relation Type  . . . . . . . . . . . . .   5
     3.1.  Documentation . . . . . . . . . . . . . . . . . . . . . .   5
     3.2.  Policy  . . . . . . . . . . . . . . . . . . . . . . . . .   6
   4.  Recommend Replacement . . . . . . . . . . . . . . . . . . . .   6
   5.  Sunset  . . . . . . . . . . . . . . . . . . . . . . . . . . .   6
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   7
     6.1.  The Deprecation Response Header Field . . . . . . . . . .   7
     6.2.  The Deprecation Link Relation Type  . . . . . . . . . . .   7
   7.  Implementation Status . . . . . . . . . . . . . . . . . . . .   8
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .   9
   9.  Example . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
   10. References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     10.1.  Normative References . . . . . . . . . . . . . . . . . .  10
     10.2.  Informative References . . . . . . . . . . . . . . . . .  11
   Appendix A.  Acknowledgments  . . . . . . . . . . . . . . . . . .  11
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  12

1.  Introduction

   Deprecation of a URI-identified resource is a technique to
   communicate information about the lifecycle of a resource.  It
   encourages applications to migrate away from the resource and
   discourage applications from forming new dependencies on the
   resource, and informs applications of 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 additional
   information such as 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
   alternate and when the deprecated resource would be unreachable, etc.
Show full document text