docs: clarify compatibility with S3 in object consistency

Change-Id: I9b942bdbeb6771e89c349723539341ffe8c511b4
storj · Jul 8, 2022 · 937dcb3 · 937dcb3
1 parent 03806db
commit 937dcb3
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/docs/s3-compatibility.md b/docs/s3-compatibility.md
@@ -9,7 +9,7 @@ S3 Compatibility
 | CompleteMultipartUpload                     | Full    |                                                              |                                                     |
 | CopyObject                                  | Full    |                                                              |                                                     |
 | CreateBucket                                | Full    |                                                              |                                                     |
-| CreateMultipartUpload                       | Full    |                                                              |                                                     |
+| CreateMultipartUpload                       | Partial |                                                              | See PutObject/MultipartUpload section               |
 | DeleteBucket                                | Full    |                                                              |                                                     |
 | DeleteBucketAnalyticsConfiguration          | No      | No                                                           |                                                     |
 | DeleteBucketCors                            | No      | No                                                           |                                                     |
@@ -89,7 +89,7 @@ S3 Compatibility
 | PutBucketTagging                            | No      | We could support this                                        |                                                     |
 | PutBucketVersioning                         | No      | Planned. See https://github.com/storj/roadmap/issues/23      |                                                     |
 | PutBucketWebsite                            | No      | No                                                           |                                                     |
-| PutObject                                   | Full    |                                                              |                                                     |
+| PutObject                                   | Partial |                                                              | See PutObject/CreateMultipartUpload section         |
 | PutObjectAcl                                | No      | No                                                           |                                                     |
 | PutObjectLegalHold                          | No      | No                                                           |                                                     |
 | PutObjectLockConfiguration                  | No      | No                                                           |                                                     |
@@ -151,6 +151,14 @@ with the same key will overwrite any existing pending uploads with the same key,
 and this endpoint will only return one upload per key. This is tracked at
 [storj/gateway-mt#149](https://github.com/storj/gateway-mt/issues/149).
 
+### PutObject/CreateMultipartUpload
+
+PutObject and CreateMultipartUpload do not have strong consistency, as described
+in [AWS S3 data consistency model](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html#ConsistencyModel).
+If multiple clients or requests are putting an object to the same key, this can
+result in "object already exists" errors being returned. There are some plans to
+improve object consistency in [storj/storj#4788](https://github.com/storj/storj/issues/4788).
+
 ### ACL-related actions
 
 [Secure access control in the decentralized