[pbs-devel] [PATCH proxmox 1/2] s3 client: api types: extend client config by optional quirks

[Christian Ebner]

Add optional provider specific quirks to the client configuration,
allowing to set a variant of the client to follow some custom
implementation variants.

Add backblaze as first variant, as it does not accept the
`If-None-Match` header in put object requests.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
 proxmox-s3-client/examples/s3_client.rs |  1 +
 proxmox-s3-client/src/api_types.rs      | 18 +++++++++++++++++-
 proxmox-s3-client/src/client.rs         |  3 +++
 3 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/proxmox-s3-client/examples/s3_client.rs b/proxmox-s3-client/examples/s3_client.rs
index 1cbb3939..25df9609 100644
--- a/proxmox-s3-client/examples/s3_client.rs
+++ b/proxmox-s3-client/examples/s3_client.rs
@@ -38,6 +38,7 @@ async fn run() -> Result<(), anyhow::Error> {
         // `openssl s_client -connect testbucket.s3.pve-c1.local:7480 < /dev/null | openssl x509 -fingerprint -sha256 -noout`
         fingerprint: Some("<s3-api-fingerprint>".to_string()),
         put_rate_limit: None,
+        quirks: None,
     };
 
     // Creating a client instance and connect to api endpoint
diff --git a/proxmox-s3-client/src/api_types.rs b/proxmox-s3-client/src/api_types.rs
index eff15f37..59fda383 100644
--- a/proxmox-s3-client/src/api_types.rs
+++ b/proxmox-s3-client/src/api_types.rs
@@ -5,7 +5,7 @@ use serde::{Deserialize, Serialize};
 use proxmox_schema::api_types::{
     CERT_FINGERPRINT_SHA256_SCHEMA, DNS_LABEL_STR, IPRE_STR, SAFE_ID_FORMAT,
 };
-use proxmox_schema::{api, const_regex, ApiStringFormat, Schema, StringSchema, Updater};
+use proxmox_schema::{api, const_regex, ApiStringFormat, EnumEntry, Schema, StringSchema, Updater};
 
 #[rustfmt::skip]
 /// Regex to match S3 endpoint full qualified domain names, including template patterns for bucket
@@ -80,6 +80,15 @@ pub const S3_BUCKET_NAME_SCHEMA: Schema = StringSchema::new("Bucket name for S3
     .max_length(63)
     .schema();
 
+/// Provider specific feature implementation quirks
+pub const S3_PROVIDER_QUIRKS_SCHEMA: Schema =
+    StringSchema::new("Provider specific feature implementation quirks.")
+        .format(&ApiStringFormat::Enum(&[EnumEntry::new(
+            "backblaze",
+            "Backblaze",
+        )]))
+        .schema();
+
 #[api(
     properties: {
         endpoint: {
@@ -109,6 +118,10 @@ pub const S3_BUCKET_NAME_SCHEMA: Schema = StringSchema::new("Bucket name for S3
             type: u64,
             optional: true,
         },
+        quirks: {
+            schema: S3_PROVIDER_QUIRKS_SCHEMA,
+            optional: true,
+        },
     },
 )]
 #[derive(Serialize, Deserialize, Updater, Clone, PartialEq)]
@@ -134,6 +147,9 @@ pub struct S3ClientConfig {
     /// Rate limit for put requests given as #reqest/s.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub put_rate_limit: Option<u64>,
+    /// Provider specific feature implementation quirks
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub quirks: Option<String>,
 }
 
 impl S3ClientConfig {
diff --git a/proxmox-s3-client/src/client.rs b/proxmox-s3-client/src/client.rs
index 3a981bf4..bbe363da 100644
--- a/proxmox-s3-client/src/client.rs
+++ b/proxmox-s3-client/src/client.rs
@@ -69,6 +69,8 @@ pub struct S3ClientOptions {
     pub fingerprint: Option<String>,
     /// Rate limit for put requests given as #reqest/s.
     pub put_rate_limit: Option<u64>,
+    /// Provider specific feature implementation quirks
+    pub quirks: Option<String>,
 }
 
 impl S3ClientOptions {
@@ -90,6 +92,7 @@ impl S3ClientOptions {
             access_key: config.access_key,
             secret_key,
             put_rate_limit: config.put_rate_limit,
+            quirks: config.quirks,
         }
     }
 }
-- 
2.47.2