Merge pull request #796 from GoogleCloudPlatform/spp--storage-doc-fixes

Update ACL docs to correct scope to entity
googleapis · Aug 12, 2015 · 4b69f3b · 4b69f3b
2 parents 32618a7 + 0a19e5c
commit 4b69f3b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/lib/storage/bucket.js b/lib/storage/bucket.js
@@ -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).
@@ -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
@@ -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) {});
    */
@@ -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`.
    *

diff --git a/lib/storage/file.js b/lib/storage/file.js
@@ -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).
@@ -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) {});
    */

diff --git a/lib/storage/index.js b/lib/storage/index.js
@@ -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")
@@ -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) {});
  *
@@ -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) {});
  */