Skip to content

Commit

Permalink
docs: changes order of parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and bcoe committed Nov 13, 2019
1 parent 883a89f commit faeb116
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 30 deletions.
1 change: 0 additions & 1 deletion packages/google-cloud-datacatalog/.nycrc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"**/docs",
"**/samples",
"**/scripts",
"**/src/**/v*/**/*.js",
"**/protos",
"**/test",
".jsdoc.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,13 @@ class DataCatalogClient {
* Note: Query tokens need to have a minimum of 3 characters for substring
* matching to work correctly. See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.
* @param {string} request.orderBy
* @param {number} [request.pageSize]
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {string} [request.orderBy]
* Specifies the ordering of results, currently supported case-sensitive
* choices are:
*
Expand All @@ -319,12 +325,6 @@ class DataCatalogClient {
* specified
*
* If not specified, defaults to `relevance` descending.
* @param {number} [request.pageSize]
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object} [options]
* Optional parameters. You can override the default settings for this call, e.g, timeout,
* retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details.
Expand Down Expand Up @@ -359,11 +359,9 @@ class DataCatalogClient {
* // Iterate over all elements.
* const scope = {};
* const query = '';
* const orderBy = '';
* const request = {
* scope: scope,
* query: query,
* orderBy: orderBy,
* };
*
* client.searchCatalog(request)
Expand All @@ -380,11 +378,9 @@ class DataCatalogClient {
* // Or obtain the paged response.
* const scope = {};
* const query = '';
* const orderBy = '';
* const request = {
* scope: scope,
* query: query,
* orderBy: orderBy,
* };
*
*
Expand Down Expand Up @@ -453,7 +449,13 @@ class DataCatalogClient {
* Note: Query tokens need to have a minimum of 3 characters for substring
* matching to work correctly. See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.
* @param {string} request.orderBy
* @param {number} [request.pageSize]
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {string} [request.orderBy]
* Specifies the ordering of results, currently supported case-sensitive
* choices are:
*
Expand All @@ -464,12 +466,6 @@ class DataCatalogClient {
* specified
*
* If not specified, defaults to `relevance` descending.
* @param {number} [request.pageSize]
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object} [options]
* Optional parameters. You can override the default settings for this call, e.g, timeout,
* retries, paginations, etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html} for the details.
Expand All @@ -486,11 +482,9 @@ class DataCatalogClient {
*
* const scope = {};
* const query = '';
* const orderBy = '';
* const request = {
* scope: scope,
* query: query,
* orderBy: orderBy,
* };
* client.searchCatalogStream(request)
* .on('data', element => {
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-datacatalog/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-10-18T11:13:41.988427Z",
"updateTime": "2019-11-09T12:12:09.084785Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.40.0",
"dockerImage": "googleapis/artman@sha256:fd2b49cce3d652929cc80157ec2d91bebe993f7cd4e89afaad80f9c785f8bf36"
"version": "0.41.1",
"dockerImage": "googleapis/artman@sha256:545c758c76c3f779037aa259023ec3d1ef2d57d2c8cd00a222cb187d63ceac5e"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "906335b5a958557e1070fc6f275171dc8a42b1ec",
"internalRef": "275374583"
"sha": "34e661f58d58fa57da8ed113a3d8bb3de26b307d",
"internalRef": "279417429"
}
},
{
Expand Down
4 changes: 0 additions & 4 deletions packages/google-cloud-datacatalog/test/gapic-v1beta1.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,9 @@ describe('DataCatalogClient', () => {
// Mock request
const scope = {};
const query = 'query107944136';
const orderBy = 'orderBy1234304744';
const request = {
scope: scope,
query: query,
orderBy: orderBy,
};

// Mock response
Expand Down Expand Up @@ -103,11 +101,9 @@ describe('DataCatalogClient', () => {
// Mock request
const scope = {};
const query = 'query107944136';
const orderBy = 'orderBy1234304744';
const request = {
scope: scope,
query: query,
orderBy: orderBy,
};

// Mock Grpc layer
Expand Down

0 comments on commit faeb116

Please sign in to comment.