Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resumable Upload: Editorial pass #2929

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Conversation

Acconut
Copy link
Member

@Acconut Acconut commented Oct 28, 2024

The document has grown organically over time as features and clarifications have been added. Unfortunately, this makes the draft harder to read and less structured.

This draft attempts to improve the situation by

  • placing a definition of "upload resource" and "target resource" at the beginning of the document (closes Move upload resource and target resource to Conventions and Definitions #2874).
  • adding a definition of a "file" and using it consistently throughout the document (we avoided using the term before because resumable uploads can also upload from streaming resources and not only files on disk, but the new definition explicitly mentions that a file can also be a streaming resource).
  • introducing a section dedicated to the upload resource, which is the main way through which client interact with resumable uploads (the section houses the description for upload offset, length, completeness, as well as the HEAD, PATCH, DELETE requests).
  • splitting the requirements for request handling into client-side and server-side requirements to make their sections more structured.

This PR is not yet completed, but any feedback is welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Move upload resource and target resource to Conventions and Definitions
1 participant