docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/jobs_v3.projects.html b/docs/dyn/jobs_v3.projects.html
index 5a32841..ee4c37a 100644
--- a/docs/dyn/jobs_v3.projects.html
+++ b/docs/dyn/jobs_v3.projects.html
@@ -90,25 +90,31 @@
<p class="firstline">Returns the jobs Resource.</p>
<p class="toc_element">
- <code><a href="#complete">complete(name, languageCode=None, pageSize=None, languageCodes=None, query=None, x__xgafv=None, scope=None, type=None, companyName=None)</a></code></p>
+ <code><a href="#complete">complete(name, pageSize=None, query=None, languageCode=None, type=None, languageCodes=None, companyName=None, scope=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the specified prefix with keyword suggestions.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="complete">complete(name, languageCode=None, pageSize=None, languageCodes=None, query=None, x__xgafv=None, scope=None, type=None, companyName=None)</code>
+ <code class="details" id="complete">complete(name, pageSize=None, query=None, languageCode=None, type=None, languageCodes=None, companyName=None, scope=None, x__xgafv=None)</code>
<pre>Completes the specified prefix with keyword suggestions.
Intended for use by a job search auto-complete search box.
Args:
name: string, Required. Resource name of project the completion is performed within.
-The format is "projects/{project_id}", for example,
-"projects/api-test-project". (required)
+The format is "projects/{project_id}", for example,
+"projects/api-test-project". (required)
+ pageSize: integer, Required. Completion result count.
+
+The maximum allowed page size is 10.
+ query: string, Required. The query used to generate suggestions.
+
+The maximum number of allowed characters is 255.
languageCode: string, Deprecated. Use language_codes instead.
Optional.
The language of the query. This is
-the BCP-47 language code, such as "en-US" or "sr-Latn".
+the BCP-47 language code, such as "en-US" or "sr-Latn".
For more information, see
[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
@@ -124,11 +130,9 @@
language_code are returned.
The maximum number of allowed characters is 255.
- pageSize: integer, Required. Completion result count.
-
-The maximum allowed page size is 10.
+ type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
languageCodes: string, Optional. The list of languages of the query. This is
-the BCP-47 language code, such as "en-US" or "sr-Latn".
+the BCP-47 language code, such as "en-US" or "sr-Latn".
For more information, see
[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
@@ -144,19 +148,15 @@
language_codes are returned.
The maximum number of allowed characters is 255. (repeated)
- query: string, Required. The query used to generate suggestions.
+ companyName: string, Optional. If provided, restricts completion to specified company.
-The maximum number of allowed characters is 255.
+The format is "projects/{project_id}/companies/{company_id}", for example,
+"projects/api-test-project/companies/foo".
+ scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
- type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
- companyName: string, Optional. If provided, restricts completion to specified company.
-
-The format is "projects/{project_id}/companies/{company_id}", for example,
-"projects/api-test-project/companies/foo".
Returns:
An object of the form:
@@ -164,22 +164,22 @@
{ # Output only.
#
# Response of auto-complete query.
- "completionResults": [ # Results of the matching job/company candidates.
- { # Output only.
- #
- # Resource that represents completion results.
- "type": "A String", # The completion topic.
- "suggestion": "A String", # The suggestion for the query.
- "imageUri": "A String", # The URI of the company image for CompletionType.COMPANY_NAME.
- },
- ],
- "metadata": { # Output only. # Additional information for the API invocation, such as the request
+ "metadata": { # Output only. # Additional information for the API invocation, such as the request
# tracking id.
#
# Additional information returned to client, such as debugging information.
- "requestId": "A String", # A unique id associated with this call.
+ "requestId": "A String", # A unique id associated with this call.
# This id is logged for tracking purposes.
},
+ "completionResults": [ # Results of the matching job/company candidates.
+ { # Output only.
+ #
+ # Resource that represents completion results.
+ "imageUri": "A String", # The URI of the company image for CompletionType.COMPANY_NAME.
+ "type": "A String", # The completion topic.
+ "suggestion": "A String", # The suggestion for the query.
+ },
+ ],
}</pre>
</div>