Skip to content

docs(services/s3): fix inverted comment on disable_list_objects_v2 #7820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xuanwo merged 2 commits into from
Jun 25, 2026
+1 −1
Merged

docs(services/s3): fix inverted comment on disable_list_objects_v2 #7820

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b06b18
docs(services/s3): fix inverted comment on disable_list_objects_v2
yangyang233333 Jun 25, 2026
0999d34
Merge branch 'main' into fix-disable-list-objects-v2-doc-comment
yangyang233333 Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/services/s3/src/backend.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ impl S3Builder {
self
}

/// Disable list objects v2 so that opendal will not use the older
/// Disable list objects v2 so that opendal will fall back to the older

@erickguan erickguan Jun 25, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Disable list objects v2 so that opendal will fall back to the older
/// Disable list objects v2 so that Openal will fall back to the older

I strongly suggest deprecating disable_ functions and to use enable instead because it takes time to understand some tricky combination of configurations.

In this case, enable_legacy_list_objects_v1 would do. It has been a while since AWS deprecate this. Doc is here.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

@Xuanwo Xuanwo Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel enable_legacy_list_objects_v1 seems to be good but that introduce a new config. I think it's find to implement as a follow-up.

/// List Objects V1 to list objects.
///
/// By default, OpenDAL uses List Objects V2 to list objects. However,
Expand Down
Loading