PB-615: Spec multipart upload process #425
Conversation
Describe multipart upload process in more details.
benschs
force-pushed
the
feat-PB-615-spec-multipart-upload
branch
from
120709d
to
196b78d
Compare
Update the supported media type list in the spec to match the actual implementation. Add mode information to the delete feature request description.
| If any errors happen during the upload process, you can [abort the upload](#tag/Asset-Upload-Management/operation/abortMultipartUpload) | ||
| and restart the process. | ||
|
|
||
| There can only be 1 upload in progress per asset. If you wish to start a new upload you must first abort any existing upload that is in progress. |
There was a problem hiding this comment.
I think this is a bit unclear. From my understanding it's OK to upload multiple parts concurrently but you cannot "overwrite" (start a new upload of) an asset for which upload has not completed (or been aborted).
There was a problem hiding this comment.
Maybe a link to this doc might be useful somewhere here: https://github.com/geoadmin/service-stac/blob/develop/doc/stac-upload-error-handling.md
There was a problem hiding this comment.
Esp. the flow chart could be of interest to some users
There was a problem hiding this comment.
I wasn't aware of that doc. Maybe it should be pulled into the API doc itself instead of being a separate document? If it needs to remain separate, I strongly support linking to it.
There was a problem hiding this comment.
Adapted the concurrent upload part sentence. I was also not aware of this document. I added the detailed description of the upload to the spec, as well as the diagram asset to the static files.
There was a problem hiding this comment.
I suggest replacing the document with a redirect to the API doc that has the content. Less copypasta to maintain.
There was a problem hiding this comment.
Yes, I removed the existing file as all the content is integrated in the spec. Also moved both diagram files to the static assets.
| </ol> | ||
|
|
||
| Any file that is larger than 5 GB must be split into multiple parts. A file part must be at | ||
| least 5 MB except for the last one and at most 5 GB, otherwise the complete operation will fail. |
There was a problem hiding this comment.
How about "except for the last (or only) one" ?
There was a problem hiding this comment.
If we want to call it out, I would add a separate sentence instead of parenthesis. "If there is only one part, it can be smaller than 5 MB since it is also the last part."
There was a problem hiding this comment.
Following this sentence there is the following sentence:
"If the file is less that 5 GB, you will only upload a single part, but must still start and complete the process as with multiple parts."
Do you think it needs more than this?
| description: Use this method to delete an existing feature/item. | ||
| description: | | ||
| Use this method to delete an existing feature/item. The feature can only be deleted if all | ||
| its assets have been deleted first. Also see [Delete an existing asset by id](#tag/Data-Management/operation/deleteAsset). |
There was a problem hiding this comment.
"See also" sounds less weird than "Also see" I think.
Detailed description of upload process and error handling. Moved from existing files found in doc/
benschs
force-pushed
the
feat-PB-615-spec-multipart-upload
branch
from
f28886f
to
8773def
Compare
Describe multipart upload process in more details. Added a quick description of the process. After talk with @boecklic we will add more detailed documentation (probably in another tool) later.