Skip to content

Commit

Permalink
fix(customsearch): update the API
Browse files Browse the repository at this point in the history
#### customsearch:v1
The following keys were changed:
- resources.cse.methods.list.description
- resources.cse.methods.list.parameters.cx.description
- resources.cse.resources.siterestrict.methods.list.description
- resources.cse.resources.siterestrict.methods.list.parameters.cx.description
- schemas.Search.properties.queries.properties.nextPage.items.properties.cx.description
- schemas.Search.properties.queries.properties.previousPage.items.properties.cx.description
- schemas.Search.properties.queries.properties.request.items.properties.cx.description
- schemas.Search.properties.url.properties.type.description
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jul 25, 2020
1 parent 932a461 commit 6e25475
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
18 changes: 9 additions & 9 deletions discovery/customsearch-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"cse": {
"methods": {
"list": {
"description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results.",
"description": "Returns metadata about the search performed, metadata about the\nengine used for the search, and the search results.",
"flatPath": "customsearch/v1",
"httpMethod": "GET",
"id": "search.cse.list",
Expand All @@ -114,7 +114,7 @@
"type": "string"
},
"cx": {
"description": "The custom search engine ID to use for this request.",
"description": "The Programmable Search Engine ID to use for this request.",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -328,7 +328,7 @@
"siterestrict": {
"methods": {
"list": {
"description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results. Uses a small set\nof url patterns.",
"description": "Returns metadata about the search performed, metadata about the\nengine used for the search, and the search results. Uses a small set\nof url patterns.",
"flatPath": "customsearch/v1/siterestrict",
"httpMethod": "GET",
"id": "search.cse.siterestrict.list",
Expand All @@ -345,7 +345,7 @@
"type": "string"
},
"cx": {
"description": "The custom search engine ID to use for this request.",
"description": "The Programmable Search Engine ID to use for this request.",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -559,7 +559,7 @@
}
}
},
"revision": "20200715",
"revision": "20200723",
"rootUrl": "https://customsearch.googleapis.com/",
"schemas": {
"Promotion": {
Expand Down Expand Up @@ -803,7 +803,7 @@
"type": "string"
},
"cx": {
"description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.",
"description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.",
"type": "string"
},
"dateRestrict": {
Expand Down Expand Up @@ -961,7 +961,7 @@
"type": "string"
},
"cx": {
"description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.",
"description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.",
"type": "string"
},
"dateRestrict": {
Expand Down Expand Up @@ -1119,7 +1119,7 @@
"type": "string"
},
"cx": {
"description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.",
"description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.",
"type": "string"
},
"dateRestrict": {
Expand Down Expand Up @@ -1310,7 +1310,7 @@
"type": "string"
},
"type": {
"description": "The MIME type of the OpenSearch URL template for the Custom Search API.",
"description": "The MIME type of the OpenSearch URL template for the Custom Search JSON\nAPI.",
"type": "string"
}
},
Expand Down
16 changes: 8 additions & 8 deletions src/apis/customsearch/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ export namespace customsearch_v1 {

/**
* search.cse.list
* @desc Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.
* @desc Returns metadata about the search performed, metadata about the engine used for the search, and the search results.
* @example
* // Before running the sample:
* // - Enable the API at:
Expand Down Expand Up @@ -456,7 +456,7 @@ export namespace customsearch_v1 {
* // Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)
* // page for a list of valid values for this parameter.
* cr: 'placeholder-value',
* // The custom search engine ID to use for this request.
* // The Programmable Search Engine ID to use for this request.
* cx: 'placeholder-value',
* // Restricts results to URLs based on date. Supported values include:
* //
Expand Down Expand Up @@ -764,7 +764,7 @@ export namespace customsearch_v1 {
* @param {object} params Parameters for request
* @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
* @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter.
* @param {string=} params.cx The custom search engine ID to use for this request.
* @param {string=} params.cx The Programmable Search Engine ID to use for this request.
* @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
* @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain.
* @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results.
Expand Down Expand Up @@ -883,7 +883,7 @@ export namespace customsearch_v1 {
*/
cr?: string;
/**
* The custom search engine ID to use for this request.
* The Programmable Search Engine ID to use for this request.
*/
cx?: string;
/**
Expand Down Expand Up @@ -1008,7 +1008,7 @@ export namespace customsearch_v1 {

/**
* search.cse.siterestrict.list
* @desc Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.
* @desc Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.
* @example
* // Before running the sample:
* // - Enable the API at:
Expand Down Expand Up @@ -1058,7 +1058,7 @@ export namespace customsearch_v1 {
* // Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)
* // page for a list of valid values for this parameter.
* cr: 'placeholder-value',
* // The custom search engine ID to use for this request.
* // The Programmable Search Engine ID to use for this request.
* cx: 'placeholder-value',
* // Restricts results to URLs based on date. Supported values include:
* //
Expand Down Expand Up @@ -1366,7 +1366,7 @@ export namespace customsearch_v1 {
* @param {object} params Parameters for request
* @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
* @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter.
* @param {string=} params.cx The custom search engine ID to use for this request.
* @param {string=} params.cx The Programmable Search Engine ID to use for this request.
* @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.
* @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain.
* @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results.
Expand Down Expand Up @@ -1490,7 +1490,7 @@ export namespace customsearch_v1 {
*/
cr?: string;
/**
* The custom search engine ID to use for this request.
* The Programmable Search Engine ID to use for this request.
*/
cx?: string;
/**
Expand Down

0 comments on commit 6e25475

Please sign in to comment.