Skip to content
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.

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

Documentation Updates #98

Open
nhandyal opened this issue Feb 1, 2022 · 0 comments
Open

Documentation Updates #98

nhandyal opened this issue Feb 1, 2022 · 0 comments

Comments

@nhandyal
Copy link
Contributor

nhandyal commented Feb 1, 2022

Thanks for creating this crate! As I'm getting started, I'm noticing some errors / shortcomings in the documentation which I want to document here so it can be updated.

In READEME.md

The service account requires the permission devstorage.full_control

It doesn't look like this is a valid permission anymore.

In READEME.md
Example

// create a new Bucket
let new_bucket = NewBucket { name: "mybucket", ..Default::default() }
let bucket = Bucket::create(new_bucket).await?;
// upload a file to our new bucket
let content = b"Your file is now on google cloud storage!";
bucket.upload(content, "folder/filename.txt", "application/text").await?;

no method named upload found for struct cloud_storage::Bucket

In the features section of docs.rs

global-client -- This feature flag does not enable additional features.

However there are methods gated by this feature. Ex: Bucket::list

Missing permissions
Bucket::read requires the storage.buckets.get permission which is not mentioned in the README. This permission is not included in the Service Account Token Creator or Storage Object Admin roles.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant