opendal 0.1.8 → 0.1.9

data/core/services/s3/src/backend.rs

@@ -725,7 +725,7 @@ impl Builder for S3Builder {
     type Config = S3Config;
 
     fn build(self) -> Result<impl Service> {
-        debug!("backend build started: {:?}", &self);
+        debug!("backend build started: {:?}", self);
 
         let S3Builder {
             mut config,
@@ -738,7 +738,7 @@ impl Builder for S3Builder {
         }
 
         let root = normalize_root(&config.root.clone().unwrap_or_default());
-        debug!("backend use root {}", &root);
+        debug!("backend use root {}", root);
 
         // Handle bucket name.
         let bucket = if Self::is_bucket_valid(&config) {
@@ -749,7 +749,7 @@ impl Builder for S3Builder {
                     .with_context("service", S3_SCHEME),
             )
         }?;
-        debug!("backend use bucket {}", &bucket);
+        debug!("backend use bucket {}", bucket);
 
         let default_storage_class = match &config.default_storage_class {
             None => None,
@@ -1006,6 +1006,7 @@ impl Builder for S3Builder {
                     presign_stat: true,
                     presign_read: true,
                     presign_write: true,
+                    presign_delete: true,
 
                     shared: true,
 
@@ -1209,10 +1210,7 @@ impl Service for S3Backend {
                 self.core
                     .s3_put_object_request(path, None, &v, Buffer::new())
             }
-            PresignOperation::Delete(_) => Err(Error::new(
-                ErrorKind::Unsupported,
-                "operation is not supported",
-            )),
+            PresignOperation::Delete(v) => self.core.s3_delete_object_request(path, &v),
             _ => Err(Error::new(
                 ErrorKind::Unsupported,
                 "operation is not supported",
@@ -1361,4 +1359,59 @@ mod tests {
             "application/json"
         );
     }
+
+    #[tokio::test]
+    async fn test_presign_stat_encodes_version_id() {
+        let backend = S3Builder::default()
+            .bucket("test")
+            .region("us-east-1")
+            .skip_signature()
+            .disable_config_load()
+            .disable_ec2_metadata()
+            .build()
+            .expect("build");
+
+        let op = OpStat::default().with_version("a+b/c=d%25&e");
+        let args = OpPresign::new(op, Duration::from_secs(3600));
+        let ctx = OperationContext::new();
+        let presigned = backend
+            .presign(&ctx, "test.txt", args)
+            .await
+            .expect("presign")
+            .into_presigned_request();
+
+        assert_eq!(
+            presigned.uri().to_string(),
+            "https://s3.us-east-1.amazonaws.com/test/test.txt?versionId=a%2Bb/c%3Dd%2525%26e"
+        );
+    }
+
+    #[tokio::test]
+    async fn test_presign_read_encodes_version_id() {
+        let backend = S3Builder::default()
+            .bucket("test")
+            .region("us-east-1")
+            .skip_signature()
+            .disable_config_load()
+            .disable_ec2_metadata()
+            .build()
+            .expect("build");
+
+        let op = OpRead::default().with_version("a+b/c=d%25&e");
+        let args = OpPresign::new(
+            PresignOperation::Read(BytesRange::default(), op),
+            Duration::from_secs(3600),
+        );
+        let ctx = OperationContext::new();
+        let presigned = backend
+            .presign(&ctx, "test.txt", args)
+            .await
+            .expect("presign")
+            .into_presigned_request();
+
+        assert_eq!(
+            presigned.uri().to_string(),
+            "https://s3.us-east-1.amazonaws.com/test/test.txt?versionId=a%2Bb/c%3Dd%2525%26e"
+        );
+    }
 }

data/core/services/s3/src/compatible_services.md

@@ -89,18 +89,26 @@ To connect to COS, we need to set:
 
 [Tigris](https://www.tigrisdata.com/) is a globally distributed S3-compatible object storage service.
 
+> Tigris serves data from the region nearest to the requester through a single global endpoint, and charges no egress fees.
+
 To connect to Tigris, we need to set:
 
-- `endpoint`: The endpoint of Tigris, for example: `https://fly.storage.tigris.dev`
+- `endpoint`: The endpoint of Tigris: `https://t3.storage.dev`
 - `region`: The region of Tigris. Please set it to `auto`.
 - `bucket`: The bucket name of Tigris.
 
+Credentials are standard S3 access keys, provided via `access_key_id`/`secret_access_key` or the `AWS_ACCESS_KEY_ID`/`AWS_SECRET_ACCESS_KEY` environment variables. See [Tigris S3 SDK docs](https://www.tigrisdata.com/docs/sdks/s3/) for details.
+
 ```rust,ignore
-builder.endpoint("https://fly.storage.tigris.dev");
+builder.endpoint("https://t3.storage.dev");
 builder.region("auto");
 builder.bucket("<bucket_name>");
 ```
 
+> `https://fly.storage.tigris.dev` is a legacy endpoint that still works, but `https://t3.storage.dev` is the current one.
+
+Tigris buckets support zero-copy [snapshots and forks](https://www.tigrisdata.com/docs/snapshots-and-forks/). A forked bucket is a regular bucket, so it can be read and written through OpenDAL like any other — useful for testing against production data without copying it.
+
 ### Wasabi Object Storage
 
 [Wasabi](https://wasabi.com/) is a s3 compatible service.

data/core/services/s3/src/core.rs

@@ -420,7 +420,7 @@ impl S3Core {
             query_args.push(format!(
                 "{}={}",
                 constants::S3_QUERY_VERSION_ID,
-                percent_decode_path(version)
+                percent_encode_path(version)
             ))
         }
         if !query_args.is_empty() {
@@ -496,7 +496,7 @@ impl S3Core {
             query_args.push(format!(
                 "{}={}",
                 constants::S3_QUERY_VERSION_ID,
-                percent_decode_path(version)
+                percent_encode_path(version)
             ))
         }
         if !query_args.is_empty() {
@@ -646,12 +646,7 @@ impl S3Core {
         self.send(ctx, req).await
     }
 
-    pub async fn s3_delete_object(
-        &self,
-        ctx: &OperationContext,
-        path: &str,
-        args: &OpDelete,
-    ) -> Result<Response<Buffer>> {
+    pub fn s3_delete_object_request(&self, path: &str, args: &OpDelete) -> Result<Request<Buffer>> {
         let p = build_abs_path(&self.root, path);
 
         let mut url = format!("{}/{}", self.endpoint, percent_encode_path(&p));
@@ -682,6 +677,16 @@ impl S3Core {
             .body(Buffer::new())
             .map_err(new_request_build_error)?;
 
+        Ok(req)
+    }
+
+    pub async fn s3_delete_object(
+        &self,
+        ctx: &OperationContext,
+        path: &str,
+        args: &OpDelete,
+    ) -> Result<Response<Buffer>> {
+        let req = self.s3_delete_object_request(path, args)?;
         self.send(ctx, req).await
     }
 
@@ -765,6 +770,9 @@ impl S3Core {
             .extension(Operation::Copy)
             .extension(ServiceOperation("CopyObject"))
             .header(constants::X_AMZ_COPY_SOURCE, &source)
+            // AWS S3 accepts CopyObject without Content-Length, but some S3-compatible
+            // providers, such as NetApp, require `Content-Length: 0` for its empty body.
+            .header(CONTENT_LENGTH, 0)
             .body(Buffer::new())
             .map_err(new_request_build_error)?;
 

data/core/services/s3/src/docs.md

@@ -1,6 +1,6 @@
 ## Capabilities
 
-This service can be used to:
+Depending on its configuration and the backing system, this service can expose:
 
 - [ ] create_dir
 - [x] stat
@@ -12,35 +12,14 @@ This service can be used to:
 - [ ] rename
 - [x] presign
 
+Inspect the effective capability set with [`opendal_core::Operator::info`] and
+[`opendal_core::OperatorInfo::capability`] after building an operator.
+
 ## Configuration
 
-- `root`: Set the work dir for backend.
-- `bucket`: Set the container name for backend.
-- `endpoint`: Set the endpoint for backend.
-- `region`: Set the region for backend.
-- `access_key_id`: Set the access_key_id for backend.
-- `secret_access_key`: Set the secret_access_key for backend.
-- `session_token`: Set the session_token for backend.
-- `default_storage_class`: Set the default storage_class for backend.
-- `server_side_encryption`: Set the server_side_encryption for backend.
-- `server_side_encryption_aws_kms_key_id`: Set the server_side_encryption_aws_kms_key_id for backend.
-- `server_side_encryption_customer_algorithm`: Set the server_side_encryption_customer_algorithm for backend.
-- `server_side_encryption_customer_key`: Set the server_side_encryption_customer_key for backend.
-- `server_side_encryption_customer_key_md5`: Set the server_side_encryption_customer_key_md5 for backend.
-- `disable_config_load`: Disable aws config load from env.
-- `enable_virtual_host_style`: Enable virtual host style.
-- `enable_request_payer`: Enable the request payer for backend.
-- `skip_signature`: Skip loading credentials and signing requests.
-- `allow_anonymous`: Deprecated. Use `skip_signature` instead.
-- `batch_max_operations`: Deprecated. S3 delete batch capability is enabled by default and this option is no longer needed.
-- `delete_max_size`: Deprecated. S3 delete batch capability is enabled by default and this option is no longer needed.
-- `disable_stat_with_override`: Deprecated. S3 stat override capabilities are enabled by default and this option is no longer needed.
-- `disable_write_with_if_match`: Deprecated. S3 write with If-Match capability is enabled by default and this option is no longer needed.
-- `enable_versioning`: Deprecated. S3 versioning capability is enabled by default and this option is no longer needed.
-- `enable_write_with_append`: Deprecated. S3 append capability is enabled by default and this option is no longer needed.
-- `default_acl`: Define the default access control list (ACL) when creating a new object. Note that some s3 services like minio do not support this option.
-
-Refer to [`S3Builder`]'s public API docs for more information.
+Use [`crate::S3Config`] for serializable configuration and this builder's
+methods for direct construction. The field and method documentation defines
+accepted values, defaults, and environment interaction.
 
 ## Temporary security credentials
 

data/core/services/s3/src/lib.rs

@@ -15,8 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
+#![doc = include_str!("../README.md")]
 #![cfg_attr(docsrs, feature(doc_cfg))]
-//! Amazon S3 service implementation for Apache OpenDAL.
+#![cfg_attr(docsrs, doc(auto_cfg))]
 #![deny(missing_docs)]
 
 mod backend;
@@ -31,10 +32,15 @@ mod writer;
 pub use backend::S3Builder as S3;
 pub use config::S3Config;
 
-/// Default scheme for s3 service.
+/// URI scheme used for service registration and scheme-driven construction.
 pub const S3_SCHEME: &str = "s3";
 
-/// Register this service into the given registry.
+/// Register this service's URI scheme or schemes with an operator registry.
+///
+/// Registration enables scheme-driven construction through
+/// [`opendal_core::Operator::from_uri`] and
+/// [`opendal_core::Operator::via_iter`]. Direct construction through
+/// [`opendal_core::Operator::new`] does not require registration.
 pub fn register_s3_service(registry: &opendal_core::OperatorRegistry) {
     registry.register::<S3>(S3_SCHEME);
 }

data/core/services/seafile/Cargo.toml

@@ -18,6 +18,7 @@
 [package]
 description = "Apache OpenDAL seafile service implementation"
 name = "opendal-service-seafile"
+readme = "README.md"
 
 authors = { workspace = true }
 edition = { workspace = true }
@@ -31,7 +32,7 @@ version = { workspace = true }
 all-features = true
 
 [dependencies]
-opendal-core = { path = "../../core", version = "0.58.0", default-features = false }
+opendal-core = { path = "../../core", version = "0.58.1", default-features = false }
 
 bytes = { workspace = true }
 http = { workspace = true }

data/core/services/seafile/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/core/services/seafile/NOTICE

@@ -0,0 +1,5 @@
+Apache OpenDAL
+Copyright 2023-2026 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

data/core/services/seafile/README.md

@@ -0,0 +1,56 @@
+# Apache OpenDAL™ Seafile Service
+
+`opendal-service-seafile` provides access to Seafile storage for applications built with
+Apache OpenDAL™.
+
+## Use through `opendal`
+
+Applications should normally enable this service through the `opendal` facade with the
+`services-seafile` feature:
+
+```shell
+cargo add opendal --features services-seafile
+```
+
+The service is available as `opendal::services::Seafile`. Configure the
+service builder, then pass it to `opendal::Operator::new`.
+
+## Use with `opendal-core`
+
+Add the split crates directly:
+
+```shell
+cargo add opendal-core opendal-service-seafile
+```
+
+Pass a configured service builder to `Operator::new`:
+
+```rust
+use opendal_core::{Operator, OperatorRegistry, Result};
+use opendal_service_seafile::{register_seafile_service, Seafile};
+
+fn build_operator(builder: Seafile) -> Result<Operator> {
+    Operator::new(builder)
+}
+
+fn register_for_uri() {
+    register_seafile_service(OperatorRegistry::get());
+}
+```
+
+`register_for_uri` is only needed for scheme-driven construction through
+`Operator::from_uri` or `Operator::via_iter`.
+
+Services that send HTTP requests also require an HTTP transport in
+`OperationContext`. See the
+[`opendal-core` composition example](https://crates.io/crates/opendal-core).
+
+## Documentation
+
+- [Service configuration and examples](https://opendal.apache.org/services/seafile)
+- [Rust API documentation](https://docs.rs/opendal-service-seafile)
+- [Apache OpenDAL documentation](https://opendal.apache.org/docs/)
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/core/services/seafile/src/backend.rs

@@ -118,10 +118,10 @@ impl Builder for SeafileBuilder {
 
     /// Builds the backend and returns the result of SeafileBackend.
     fn build(self) -> Result<impl Service> {
-        debug!("backend build started: {:?}", &self);
+        debug!("backend build started: {:?}", self);
 
         let root = normalize_root(&self.config.root.clone().unwrap_or_default());
-        debug!("backend use root {}", &root);
+        debug!("backend use root {}", root);
 
         // Handle bucket.
         if self.config.repo_name.is_empty() {
@@ -130,7 +130,7 @@ impl Builder for SeafileBuilder {
                 .with_context("service", SEAFILE_SCHEME));
         }
 
-        debug!("backend use repo_name {}", &self.config.repo_name);
+        debug!("backend use repo_name {}", self.config.repo_name);
 
         let endpoint = match &self.config.endpoint {
             Some(endpoint) => Ok(endpoint.clone()),

data/core/services/seafile/src/docs.md

@@ -1,6 +1,6 @@
 ## Capabilities
 
-This service can be used to:
+Depending on its configuration and the backing system, this service can expose:
 
 - [ ] create_dir
 - [x] stat
@@ -12,15 +12,14 @@ This service can be used to:
 - [ ] rename
 - [ ] presign
 
-## Configuration
+Inspect the effective capability set with [`opendal_core::Operator::info`] and
+[`opendal_core::OperatorInfo::capability`] after building an operator.
 
-- `root`: Set the work directory for backend
-- `endpoint`: Seafile endpoint address
-- `username` Seafile username
-- `password` Seafile password
-- `repo_name` Seafile repo name
+## Configuration
 
-You can refer to [`SeafileBuilder`]'s docs for more information
+Use [`crate::SeafileConfig`] for serializable configuration and this builder's
+methods for direct construction. The field and method documentation defines
+accepted values, defaults, and environment interaction.
 
 ## Example
 

data/core/services/seafile/src/lib.rs

@@ -15,10 +15,20 @@
 // specific language governing permissions and limitations
 // under the License.
 
-/// Default scheme for seafile service.
+#![doc = include_str!("../README.md")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, doc(auto_cfg))]
+#![deny(missing_docs)]
+
+/// URI scheme used for service registration and scheme-driven construction.
 pub const SEAFILE_SCHEME: &str = "seafile";
 
-/// Register this service into the given registry.
+/// Register this service's URI scheme or schemes with an operator registry.
+///
+/// Registration enables scheme-driven construction through
+/// [`opendal_core::Operator::from_uri`] and
+/// [`opendal_core::Operator::via_iter`]. Direct construction through
+/// [`opendal_core::Operator::new`] does not require registration.
 pub fn register_seafile_service(registry: &opendal_core::OperatorRegistry) {
     registry.register::<Seafile>(SEAFILE_SCHEME);
 }

data/core/services/sftp/Cargo.toml

@@ -18,6 +18,7 @@
 [package]
 description = "Apache OpenDAL SFTP service implementation"
 name = "opendal-service-sftp"
+readme = "README.md"
 
 authors = { workspace = true }
 edition = { workspace = true }
@@ -31,7 +32,7 @@ version = { workspace = true }
 all-features = true
 
 [dependencies]
-opendal-core = { path = "../../core", version = "0.58.0", default-features = false }
+opendal-core = { path = "../../core", version = "0.58.1", default-features = false }
 
 bytes = { workspace = true }
 fastpool = "1.0.2"