Skip to content

docs: audit #2151

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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions packages/datastore/src/query.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ function Query(scope, namespace, kinds) {
*
* *To filter by ancestors, see {module:datastore/query#hasAncestor}.*
*
* @resource [Datastore Filters]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Filters}
* @resource [Datastore Filters]{@link https://cloud.google.com/datastore/docs/concepts/queries#datastore-property-filter-nodejs}
*
* @param {string} property - The field name.
* @param {string=} operator - Operator (=, <, >, <=, >=). Default: `=`
Expand Down Expand Up @@ -119,7 +119,7 @@ Query.prototype.filter = function(property, operator, value) {
/**
* Filter a query by ancestors.
*
* @resource [Datastore Ancestor Filters]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Ancestor_filters}
* @resource [Datastore Ancestor Filters]{@link https://cloud.google.com/datastore/docs/concepts/queries#datastore-ancestor-query-nodejs}
*
* @param {Key} key - Key object to filter by.
* @return {module:datastore/query}
Expand All @@ -136,7 +136,7 @@ Query.prototype.hasAncestor = function(key) {
* Sort the results by a property name in ascending or descending order. By
* default, an ascending sort order will be used.
*
* @resource [Datastore Sort Orders]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Sort_orders}
* @resource [Datastore Sort Orders]{@link https://cloud.google.com/datastore/docs/concepts/queries#datastore-ascending-sort-nodejs}
*
* @param {string} property - The property to order by.
* @param {object=} options - Options object.
Expand Down Expand Up @@ -200,7 +200,7 @@ Query.prototype.select = function(fieldNames) {
/**
* Set a starting cursor to a query.
*
* @resource [Query Cursors]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Query_cursors}
* @resource [Query Cursors]{@link https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets}

This comment was marked as spam.

*
* @param {string} cursorToken - The starting cursor token.
* @return {module:datastore/query}
Expand Down Expand Up @@ -238,7 +238,7 @@ Query.prototype.end = function(end) {
/**
* Set a limit on a query.
*
* @resource [Query Limits]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Retrieving_results}
* @resource [Query Limits]{@link https://cloud.google.com/datastore/docs/concepts/queries#datastore-limit-nodejs}
*
* @param {number} n - The number of results to limit the query to.
* @return {module:datastore/query}
Expand All @@ -255,7 +255,7 @@ Query.prototype.limit = function(n) {
/**
* Set an offset on a query.
*
* @resource [Query Offsets]{@link https://cloud.google.com/datastore/docs/concepts/queries#Datastore_Retrieving_results}
* @resource [Query Offsets]{@link https://cloud.google.com/datastore/docs/concepts/queries#datastore-limit-nodejs}
*
* @param {number} n - The offset to start from after the start cursor.
* @return {module:datastore/query}
Expand Down
6 changes: 3 additions & 3 deletions packages/logging/src/entry.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ var eventId = new EventId();
/**
* Create an entry object to define new data to insert into a log.
*
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry}
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
*
* @alias module:logging/entry
* @constructor
*
* @param {object=} metadata - See a
* [LogEntry Resource](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry).
* [LogEntry Resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry).
* @param {object|string} data - The data to use as the value for this log
* entry.
*
Expand Down Expand Up @@ -109,7 +109,7 @@ function Entry(metadata, data) {
* @private
*
* @param {object} entry - An API representation of an entry. See a
* [LogEntry](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry).
* [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry).
* @return {module:logging/entry}
*/
Entry.fromApiResponse_ = function(entry) {
Expand Down
18 changes: 9 additions & 9 deletions packages/logging/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,16 @@ util.inherits(Logging, commonGrpc.Service);
/**
* Create a sink.
*
* @resource [Sink Overview]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks}
* @resource [Sink Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks}
* @resource [Advanced Logs Filters]{@link https://cloud.google.com/logging/docs/view/advanced_filters}
* @resource [projects.sinks.create API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks/create}
* @resource [projects.sinks.create API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create}
*
* @throws {Error} if a name is not provided.
* @throws {Error} if a config object is not provided.
*
* @param {string} name - Name of the sink.
* @param {object} config - See a
* [Sink resource](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks#LogSink).
* [Sink resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink).
* @param {module:storage/bucket|module:bigquery/dataset|module:pubsub/topic} config.destination -
* The destination. The proper ACL scopes will be granted to the provided
* destination.
Expand Down Expand Up @@ -191,10 +191,10 @@ Logging.prototype.createSink = function(name, config, callback) {
* use the object returned in other API calls, such as
* {module:logging/log#write}.
*
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry}
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
*
* @param {object=|string=} resource - See a
* [Monitored Resource](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource).
* [Monitored Resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource).
* @param {object|string} data - The data to use as the value for this log
* entry.
* @return {module:logging/entry}
Expand Down Expand Up @@ -233,7 +233,7 @@ Logging.prototype.entry = function(resource, data) {
/**
* List the entries in your logs.
*
* @resource [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/entries/list}
* @resource [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list}
*
* @param {object=} options - Filtering options.
* @param {boolean} options.autoPaginate - Have pagination handled
Expand Down Expand Up @@ -352,7 +352,7 @@ Logging.prototype.getEntriesStream = common.paginator.streamify('getEntries');
/**
* Get the sinks associated with this project.
*
* @resource [projects.sinks.list API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks/list}
* @resource [projects.sinks.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list}
*
* @param {object=} options - Configuration object.
* @param {boolean} options.autoPaginate - Have pagination handled
Expand Down Expand Up @@ -449,7 +449,7 @@ Logging.prototype.getSinksStream = common.paginator.streamify('getSinks');
/**
* Get a reference to a Stackdriver Logging log.
*
* @resource [Log Overview]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.logs}
* @resource [Log Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs}
*
* @param {string} name - Name of the existing log.
* @param {object=} options - Configuration object.
Expand All @@ -467,7 +467,7 @@ Logging.prototype.log = function(name, options) {
/**
* Get a reference to a Stackdriver Logging sink.
*
* @resource [Sink Overview]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks}
* @resource [Sink Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks}
*
* @param {string} name - Name of the existing sink.
* @return {module:logging/sink}
Expand Down
12 changes: 6 additions & 6 deletions packages/logging/src/log.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var Metadata = require('./metadata.js');
* produced by the Apache Web Server, but the log
* `compute.googleapis.com/activity_log` is produced by Google Compute Engine.
*
* @resource [Introduction to Logs]{@link https://cloud.google.com/logging/docs/api/#logs}
* @resource [Introduction to Logs]{@link https://cloud.google.com/logging/docs/basic-concepts#logs}
*
* @alias module:logging/log
* @constructor
Expand All @@ -77,7 +77,7 @@ function Log(logging, name, options) {
/**
* Delete the log.
*
* @resource [projects.logs.delete API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.logs/delete}
* @resource [projects.logs.delete API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs/delete}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
Expand Down Expand Up @@ -263,10 +263,10 @@ Log.prototype.emergency = function(entry, options, callback) {
* use the object returned in other API calls, such as
* {module:logging/log#write}.
*
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry}
* @resource [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
*
* @param {object=} metadata - See a
* [LogEntry Resource](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/LogEntry).
* [LogEntry Resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry).
* @param {object|string} data - The data to use as the value for this log
* entry.
* @return {module:logging/entry}
Expand Down Expand Up @@ -342,7 +342,7 @@ Log.prototype.error = function(entry, options, callback) {
* This method is a wrapper around {module:logging#getEntries}, but with a
* filter specified to only return entries from this log.
*
* @resource [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/entries/list}
* @resource [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list}
*
* @param {object=} options - Filtering options.
* @param {boolean} options.autoPaginate - Have pagination handled
Expand Down Expand Up @@ -518,7 +518,7 @@ Log.prototype.warning = function(entry, options, callback) {
* While you may write a single entry at a time, batching multiple entries
* together is preferred to avoid reaching the queries per second limit.
*
* @resource [entries.write API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/entries/write}
* @resource [entries.write API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write}
*
* @param {module:logging/entry|module:logging/entry[]} entry - A log entry, or
* array of entries, to write.
Expand Down
14 changes: 7 additions & 7 deletions packages/logging/src/sink.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var util = require('util');
* storage), Google BigQuery datasets (for log analysis), Google Pub/Sub (for
* streaming to other applications).
*
* @resource [Introduction to Sinks]{@link https://cloud.google.com/logging/docs/api/#sinks}
* @resource [Introduction to Sinks]{@link https://cloud.google.com/logging/docs/basic-concepts#sinks}
*
* @alias module:logging/sink
* @constructor
Expand Down Expand Up @@ -82,7 +82,7 @@ function Sink(logging, name) {
/**
* Delete the sink.
*
* @resource [projects.sink.delete API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks/delete}
* @resource [projects.sink.delete API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/delete}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
Expand Down Expand Up @@ -116,8 +116,8 @@ function Sink(logging, name) {
/**
* Get the sink's metadata.
*
* @resource [Sink Resource]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks#LogSink}
* @resource [projects.sink.get API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks/get}
* @resource [Sink Resource]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink}
* @resource [projects.sink.get API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/get}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
Expand Down Expand Up @@ -192,11 +192,11 @@ Sink.prototype.setFilter = function(filter, callback) {
/**
* Set the sink's metadata.
*
* @resource [Sink Resource]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks#LogSink}
* @resource [projects.sink.update API Documentation]{@link https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks/update}
* @resource [Sink Resource]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink}
* @resource [projects.sink.update API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/update}
*
* @param {object} metadata - See a
* [Sink resource](https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.sinks#LogSink).
* [Sink resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink).
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
* request.
Expand Down
8 changes: 4 additions & 4 deletions packages/storage/src/bucket.js
Original file line number Diff line number Diff line change
Expand Up @@ -256,14 +256,14 @@ function Bucket(storage, name) {
* the ACLs defined on your bucket, as well as set, update, and delete them.
*
* Buckets also have
* [default ACLs](https://cloud.google.com/storage/docs/accesscontrol#default)
* [default ACLs](https://cloud.google.com/storage/docs/access-control/lists#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 entities and permissions for these as well with
* {module:storage/bucket#acl.default}.
*
* @resource [About Access Control Lists]{@link http://goo.gl/6qBBPO}
* @resource [Default ACLs]{@link https://cloud.google.com/storage/docs/accesscontrol#default}
* @resource [Default ACLs]{@link https://cloud.google.com/storage/docs/access-control/lists#default}
*
* @mixes module:storage/acl
*
Expand Down Expand Up @@ -294,8 +294,8 @@ function Bucket(storage, name) {
});

/**
* Cloud Storage Buckets have [default ACLs](http://goo.gl/YpGdyv) for
* all created files. You can add, delete, get, and update entities and
* Cloud Storage Buckets have [default ACLs](https://cloud.google.com/storage/docs/access-control/lists#default)
* for 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
10 changes: 5 additions & 5 deletions packages/storage/src/file.js
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ File.prototype.createReadStream = function(options) {
* Create a unique resumable upload session URI. This is the first step when
* performing a resumable upload.
*
* See the [Resumable upload guide](https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload#resumable)
* See the [Resumable upload guide](https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload)
* for more on how the entire process works.
*
* <h4>Note</h4>
Expand All @@ -753,7 +753,7 @@ File.prototype.createReadStream = function(options) {
* any of the details, see {module:storage/createWriteStream}. Resumable uploads
* are performed by default.
*
* @resource [Resumable upload guide]{@link https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload#resumable}
* @resource [Resumable upload guide]{@link https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload}
*
* @param {object=} options - Configuration object.
* @param {object} options.metadata - Metadata to set on the file.
Expand Down Expand Up @@ -843,7 +843,7 @@ File.prototype.createResumableUpload = function(options, callback) {
* NOTE: Writable streams will emit the `finish` event when the file is fully
* uploaded.
*
* @resource [Upload Options (Simple or Resumable)]{@link https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload#uploads}
* @resource [Upload Options (Simple or Resumable)]{@link https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload}
* @resource [Objects: insert API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/insert}
*
* @param {object=} options - Configuration object.
Expand Down Expand Up @@ -1183,7 +1183,7 @@ File.prototype.setEncryptionKey = function(encryptionKey) {
* Get a signed policy document to allow a user to upload data with a POST
* request.
*
* @resource [Policy Document Reference]{@link https://cloud.google.com/storage/docs/reference-methods#policydocument}
* @resource [Policy Document Reference]{@link https://cloud.google.com/storage/docs/xml-api/post-object#policydocument}
*
* @throws {Error} If an expiration timestamp from the past is given.
* @throws {Error} If options.equals has an array with less or more than two
Expand Down Expand Up @@ -1351,7 +1351,7 @@ File.prototype.getSignedPolicy = function(options, callback) {
/**
* Get a signed URL to allow limited time access to the file.
*
* @resource [Signed URLs Reference]{@link https://cloud.google.com/storage/docs/access-control#Signed-URLs}
* @resource [Signed URLs Reference]{@link https://cloud.google.com/storage/docs/access-control/signed-urls}
*
* @throws {Error} if an expiration timestamp from the past is given.
*
Expand Down
2 changes: 1 addition & 1 deletion packages/storage/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ util.inherits(Storage, common.Service);
* - `gcs.acl.READER_ROLE` - ("READER")
* - `gcs.acl.WRITER_ROLE` - ("WRITER")
*
* @resource [About Access Control Lists]{@link https://cloud.google.com/storage/docs/access-control#About-Access-Control-Lists}
* @resource [About Access Control Lists]{@link https://cloud.google.com/storage/docs/access-control/lists}
*
* @type {object}
*
Expand Down