aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/api/api_server.rs3
-rw-r--r--src/api/helpers.rs6
2 files changed, 5 insertions, 4 deletions
diff --git a/src/api/api_server.rs b/src/api/api_server.rs
index b67ebef7..74142453 100644
--- a/src/api/api_server.rs
+++ b/src/api/api_server.rs
@@ -263,7 +263,8 @@ async fn handler_inner(garage: Arc<Garage>, req: Request<Body>) -> Result<Respon
}
}
-/// Extract the bucket name and the key name from an HTTP path and possibly Host header
+/// Extract the bucket name and the key name from an HTTP path and possibly a bucket provided in
+/// the host header of the request
///
/// S3 internally manages only buckets and keys. This function splits
/// an HTTP path to get the corresponding bucket name and key.
diff --git a/src/api/helpers.rs b/src/api/helpers.rs
index 9ba32537..2375d35d 100644
--- a/src/api/helpers.rs
+++ b/src/api/helpers.rs
@@ -3,9 +3,9 @@ use idna::domain_to_unicode;
/// Host to bucket
///
-/// Convert a host, like "bucket.garage-site.tld" or "john.doe.com"
-/// to the corresponding bucket, resp. "bucket" and "john.doe.com"
-/// considering that ".garage-site.tld" is the "root domain".
+/// Convert a host, like "bucket.garage-site.tld" to the corresponding bucket "bucket",
+/// considering that ".garage-site.tld" is the "root domain". For domains not matching
+/// the provided root domain, no bucket is returned
/// This behavior has been chosen to follow AWS S3 semantic.
pub fn host_to_bucket<'a>(host: &'a str, root: &str) -> Option<&'a str> {
let root = root.trim_start_matches('.');