Merge pull request #359 from ryanseys/fix-storage-roles

fix storage acl roles documentation
googleapis · Jan 20, 2015 · b000f81 · b000f81
2 parents ef34525 + 2e5a132
commit b000f81
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 17 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -96,7 +96,8 @@ var util = require('./common/util.js');
  * //     projectId: 'my-project'
  * //   });
  *
- * var bucket = gcloud.storage.bucket({
+ * var storage = gcloud.storage();
+ * var bucket = storage.bucket({
  *   name: 'PhotosBucket',
  *   // properties may be overridden:
  *   keyFilename: '/path/to/other/keyfile.json'

diff --git a/lib/storage/bucket.js b/lib/storage/bucket.js
@@ -76,13 +76,14 @@ var RESUMABLE_THRESHOLD = 5000000;
  *
  * @example
  * var gcloud = require('gcloud');
+ * var storage = gcloud.storage();
  *
  * // From Google Compute Engine
- * var albums = gcloud.storage.bucket('albums');
+ * var albums = storage.bucket('albums');
  *
  * // From elsewhere
- * var photos = gcloud.storage.bucket({
- *   keyFilename: '/path/to/keyfile.json',
+ * var photos = storage.bucket({
+ *   keyFilename: '/path/to/keyfile.json', // If you have not yet provided it.
  *   name: 'bucket'
  * });
  */
@@ -126,7 +127,7 @@ function Bucket(storage, name) {
    * //-
    * myBucket.acl.add({
    *   scope: 'allUsers',
-   *   permission: Storage.acl.READER_ROLE
+   *   permission: storage.acl.READER_ROLE
    * }, function(err, aclObject) {});
    */
   this.acl = new Acl({

diff --git a/lib/storage/file.js b/lib/storage/file.js
@@ -101,7 +101,7 @@ function File(bucket, name, metadata) {
    * //-
    * myFile.acl.add({
    *   scope: 'allUsers',
-   *   permission: Storage.acl.READER_ROLE
+   *   permission: storage.acl.READER_ROLE
    * }, function(err, aclObject) {});
    */
   this.acl = new Acl({

diff --git a/lib/storage/index.js b/lib/storage/index.js
@@ -74,7 +74,8 @@ var STORAGE_BASE_URL = 'https://www.googleapis.com/storage/v1/b';
  * //-
  *
  * // Access `storage` through the `gcloud` module directly.
- * var musicBucket = gcloud.storage().bucket('music');
+ * var storage = gcloud.storage();
+ * var musicBucket = storage.bucket('music');
  *
  * //-
  * // Elsewhere.
@@ -86,8 +87,10 @@ var STORAGE_BASE_URL = 'https://www.googleapis.com/storage/v1/b';
  *   projectId: 'my-project'
  * });
  *
- * var albums = myProject.storage().bucket('albums');
- * var photos = myProject.storage().bucket('photos');
+ * // Use default configuration details.
+ * var storage = myProject.storage();
+ * var albums = storage.bucket('albums');
+ * var photos = storage.bucket('photos');
  *
  *
  * // Override default configuration details.
@@ -118,9 +121,9 @@ function Storage(config) {
  * This object provides constants to refer to the three permission levels that
  * can be granted to a scope:
  *
- *   - `Storage.acl.OWNER_ROLE` - ("OWNER")
- *   - `Storage.acl.READER_ROLE` - ("READER")
- *   - `Storage.acl.WRITER_ROLE` - ("WRITER")
+ *   - `storage.acl.OWNER_ROLE` - ("OWNER")
+ *   - `storage.acl.READER_ROLE` - ("READER")
+ *   - `storage.acl.WRITER_ROLE` - ("WRITER")
  *
  * For more detailed information, see
  * [About Access Control Lists](http://goo.gl/6qBBPO).
@@ -136,15 +139,15 @@ function Storage(config) {
  * //-
  * albums.acl.add({
  *   scope: 'allUsers',
- *   permission: Storage.acl.READER_ROLE
+ *   permission: storage.acl.READER_ROLE
  * }, function(err, aclObject) {});
  *
  * //-
  * // Make any new objects added to a bucket publicly readable.
  * //-
  * albums.acl.default.add({
  *   scope: 'allUsers',
- *   permission: Storage.acl.READER_ROLE
+ *   permission: storage.acl.READER_ROLE
  * }, function(err, aclObject) {});
  *
  * //-
@@ -153,7 +156,7 @@ function Storage(config) {
  *
  * albums.acl.add({
  *   scope: 'user-useremail@example.com',
- *   permission: Storage.acl.OWNER_ROLE
+ *   permission: storage.acl.OWNER_ROLE
  * }, function(err, aclObject) {});
  */
 Storage.acl = {
@@ -175,8 +178,10 @@ Storage.prototype.acl = Storage.acl;
  *   keyFilename: '/path/to/keyfile.json'
  * });
  *
- * var albums = gcloud.storage().bucket('albums');
- * var photos = gcloud.storage().bucket('photos');
+ * var storage = gcloud.storage();
+ *
+ * var albums = storage.bucket('albums');
+ * var photos = storage.bucket('photos');
  */
 Storage.prototype.bucket = function(name) {
   return new Bucket(this, name);