Skip to content

Update ACL docs to correct scope to entity #796

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
callmehiphop merged 1 commit into from
Aug 12, 2015
Merged

Update ACL docs to correct scope to entity #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions lib/storage/bucket.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,10 @@ function Bucket(storage, name) {
* users and allow other users to access your buckets and objects.
*
* An ACL consists of one or more entries, where each entry grants permissions
* to a scope. Permissions define the actions that can be performed against an
* object or bucket (for example, `READ` or `WRITE`); the scope defines who
* the permission applies to (for example, a specific user or group of users).
* to an entity. Permissions define the actions that can be performed against
* an object or bucket (for example, `READ` or `WRITE`); the entity defines
* who the permission applies to (for example, a specific user or group of
* users).
*
* For more detailed information, see
* [About Access Control Lists](http://goo.gl/6qBBPO).
Expand All @@ -121,7 +122,7 @@ function Bucket(storage, name) {
* [default ACLs](https://cloud.google.com/storage/docs/accesscontrol#default)
* for all created files. Default ACLs specify permissions that all new
* objects added to the bucket will inherit by default. You can add, delete,
* get, and update scopes and permissions for these as well with
* get, and update entities and permissions for these as well with
* {module:storage/bucket#acl.default}.
*
* @mixes module:storage/acl
Expand All @@ -132,7 +133,7 @@ function Bucket(storage, name) {
* //-
* var myBucket = gcs.bucket('my-bucket');
* myBucket.acl.add({
* scope: 'allUsers',
* entity: 'allUsers',
* role: gcs.acl.READER_ROLE
* }, function(err, aclObject) {});
*/
Expand All @@ -156,7 +157,7 @@ function Bucket(storage, name) {
*/
/**
* Google Cloud Storage Buckets have [default ACLs](http://goo.gl/YpGdyv) for
* all created files. You can add, delete, get, and update scopes and
* all created files. You can add, delete, get, and update entities and
* permissions for these as well. The method signatures and examples are all
* the same, after only prefixing the method call with `default`.
*
Expand Down
9 changes: 5 additions & 4 deletions lib/storage/file.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,10 @@ function File(bucket, name, options) {
* users and allow other users to access your buckets and objects.
*
* An ACL consists of one or more entries, where each entry grants permissions
* to a scope. Permissions define the actions that can be performed against an
* object or bucket (for example, `READ` or `WRITE`); the scope defines who
* the permission applies to (for example, a specific user or group of users).
* to an entity. Permissions define the actions that can be performed against
* an object or bucket (for example, `READ` or `WRITE`); the entity defines
* who the permission applies to (for example, a specific user or group of
* users).
*
* For more detailed information, see
* [About Access Control Lists](http://goo.gl/6qBBPO).
Expand All @@ -117,7 +118,7 @@ function File(bucket, name, options) {
* var myFile = gcs.bucket('my-bucket').file('my-file');
*
* myFile.acl.add({
* scope: 'allUsers',
* entity: 'allUsers',
* role: gcs.acl.READER_ROLE
* }, function(err, aclObject) {});
*/
Expand Down
8 changes: 4 additions & 4 deletions lib/storage/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ function Storage(options) {
* users and allow other users to access your buckets and objects.
*
* This object provides constants to refer to the three permission levels that
* can be granted to a scope:
* can be granted to an entity:
*
* - `gcs.acl.OWNER_ROLE` - ("OWNER")
* - `gcs.acl.READER_ROLE` - ("READER")
Expand All @@ -131,15 +131,15 @@ function Storage(options) {
* // Make all of the files currently in a bucket publicly readable.
* //-
* albums.acl.add({
* scope: 'allUsers',
* entity: 'allUsers',
* role: gcs.acl.READER_ROLE
* }, function(err, aclObject) {});
*
* //-
* // Make any new objects added to a bucket publicly readable.
* //-
* albums.acl.default.add({
* scope: 'allUsers',
* entity: 'allUsers',
* role: gcs.acl.READER_ROLE
* }, function(err, aclObject) {});
*
Expand All @@ -148,7 +148,7 @@ function Storage(options) {
* //-
*
* albums.acl.add({
* scope: 'user-useremail@example.com',
* entity: 'user-useremail@example.com',
* role: gcs.acl.OWNER_ROLE
* }, function(err, aclObject) {});
*/
Expand Down