Partial Uploads in HTTP
draft-wright-http-partial-upload-01

Document Type Active Internet-Draft (individual)
Last updated 2019-12-05
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized 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)
HTTP                                                           A. Wright
Internet-Draft                                         December 05, 2019
Intended status: Experimental
Expires: June 7, 2020

                        Partial Uploads in HTTP
                  draft-wright-http-partial-upload-01

Abstract

   This document specifies a new media type intended for use in PATCH
   payloads that allows a resource to be uploaded in several segments,
   instead of a single large request.

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 June 7, 2020.

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
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Wright                    Expires June 7, 2020                  [Page 1]
Internet-Draft           Partial Uploads in HTTP           December 2019

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   2
   2.  Modifying a content range with PATCH  . . . . . . . . . . . .   3
   3.  Segmented upload with PATCH . . . . . . . . . . . . . . . . .   3
     3.1.  Example . . . . . . . . . . . . . . . . . . . . . . . . .   4
   4.  Registrations . . . . . . . . . . . . . . . . . . . . . . . .   5
     4.1.  2__ (Sparse Resource) status code . . . . . . . . . . . .   5
     4.2.  message/byterange media type  . . . . . . . . . . . . . .   6
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
     5.1.  Unallocated ranges  . . . . . . . . . . . . . . . . . . .   6
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   7
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   7

1.  Introduction

   This introduces a mechanism that allows user agents to upload a
   document over several requests.  Similar solutions have been known as
   partial uploads, segmented uploading, or resumable uploads.

   HTTP is a stateless protocol, which implies that if a request is
   interrupted, there can be no way to resume it.  This is not normally
   an issue if there is an alternate way of arriving to the desired
   state from an incomplete state transition.  For example, if a
   download is interrupted, the user-agent may request just the missing
   parts in a Range request.  However, if an upload is interrupted, no
   method exists for the client to synchronize its state with the server
   and only upload the remaining data; the entire request must be
   canceled and retried.  This document standardizes a media type for
   PATCH and a new status code for uploading new resources over several
   segmented requests.

1.1.  Notational Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in BCP
   14 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

   This document uses ABNF as defined in [RFC5234] and imports grammar
   rules from [RFC7230].

   For brevity, example HTTP requests or responses may add newlines or
   whitespace, or omit some headers necessary for message transfer.

Wright                    Expires June 7, 2020                  [Page 2]
Internet-Draft           Partial Uploads in HTTP           December 2019

2.  Modifying a content range with PATCH

   The PATCH method [RFC5789] allows a client to modify a resource in a
   specific way, as specified by the request payload.  This document
   formalizes the concept of using "multipart/byteranges" [RFC7233] as a
Show full document text