Add compatibility list

2024-11-21 23:51:00 +00:00 · 2021-02-19 19:10:23 +01:00 · 2021-02-19 19:10:23 +01:00 · 5d1fa591d9
commit 5d1fa591d9
parent e64ecbdccd
3 changed files with 85 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -18,6 +18,8 @@ Non-goals include:

 Our main use case is to provide a distributed storage layer for small-scale self hosted services such as [Deuxfleurs](https://deuxfleurs.fr).

+Check our [compatibility page](doc/Compatibility.md) to view details of the S3 API compatibility.
+
 ## Development

 We propose the following quickstart to setup a full dev. environment as quickly as possible:
--- a/doc/Compatibility.md
+++ b/doc/Compatibility.md
@ -0,0 +1,82 @@
+## S3 Compatibility status
+
+### Global S3 features
+
+Implemented:
+
+- putting and getting objects in buckets
+- multipart uploads
+- listing objects
+- access control on a per-key-per-bucket basis
+
+Not implemented:
+
+- object-level ACL
+- encryption
+- most `x-amz-` headers
+
+
+### Endpoint implementation
+
+All APIs that are not mentionned are not implemented and will return a 400 bad request.
+
+#### AbortMultipartUpload
+
+Implemented.
+
+#### CompleteMultipartUpload
+
+Implemented badly. Garage will not check that all the parts stored correspond to the list given by the client in the request body. This means that the multipart upload might be completed with an invalid size. This is a bug and will be fixed.
+
+#### CopyObject
+
+Implemented.
+
+#### CreateBucket
+
+Garage does not accept creating buckets or giving access using API calls, it has to be done using the CLI tools. CreateBucket will return a 200 if the bucket exists and user has write access, and a 403 Forbidden in all other cases.
+
+#### CreateMultipartUpload
+
+Implemented.
+
+#### DeleteBucket
+
+Garage does not accept deleting buckets using API calls, it has to be done using the CLI tools. This request will return a 403 Forbidden.
+
+#### DeleteObject
+
+Implemented.
+
+#### DeleteObjects
+
+Implemented.
+
+#### GetObject
+
+Implemented.
+
+#### HeadBucket
+
+Implemented.
+
+#### HeadObject
+
+Implemented.
+
+#### ListObjects
+
+Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.
+
+#### ListObjectsV2
+
+Implemented.
+
+#### PutObject
+
+Implemented.
+
+#### UploadPart
+
+Implemented.
+
--- a/src/api/api_server.rs
+++ b/src/api/api_server.rs
@ -198,7 +198,7 @@ async fn handler_inner(garage: Arc<Garage>, req: Request<Body>) -> Result<Respon
 				))
 			}
 			&Method::GET => {
-				// ListObjects query
+				// ListObjects or ListObjectsV2 query
 				let q = parse_list_objects_query(bucket, &params)?;
 				Ok(handle_list(garage, &q).await?)
 			}