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/script_v1.projects.deployments.html b/docs/dyn/script_v1.projects.deployments.html
index 7312993..1ea25f2 100644
--- a/docs/dyn/script_v1.projects.deployments.html
+++ b/docs/dyn/script_v1.projects.deployments.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(scriptId, deploymentId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a deployment of an Apps Script project.</p>
<p class="toc_element">
- <code><a href="#list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(scriptId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the deployments of an Apps Script project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -98,15 +98,15 @@
<pre>Creates a deployment of an Apps Script project.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
body: object, The request body.
The object takes the form of:
{ # Metadata the defines how a deployment is configured.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
}
x__xgafv: string, V1 error format.
@@ -118,38 +118,38 @@
An object of the form:
{ # Representation of a single script deployment.
- "entryPoints": [ # The deployment's entry points.
+ "deploymentId": "A String", # The deployment ID for this deployment.
+ "updateTime": "A String", # Last modified date time stamp.
+ "entryPoints": [ # The deployment's entry points.
{ # A configuration that defines how a deployment is accessed externally.
- "entryPointType": "A String", # The type of the entry point.
- "webApp": { # A web application entry point. # An entry point specification for web apps.
- "url": "A String", # The URL for the web application.
- "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
- "executeAs": "A String", # Who to execute the web app as.
- "access": "A String", # Who has permission to run the web app.
+ "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
+ "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the API executable.
},
},
- "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
- "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
- "access": "A String", # Who has permission to run the API executable.
+ "webApp": { # A web application entry point. # An entry point specification for web apps.
+ "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the web app.
+ "executeAs": "A String", # Who to execute the web app as.
},
+ "url": "A String", # The URL for the web application.
},
- "addOn": { # An add-on entry point. # Add-on properties.
- "reportIssueUrl": "A String", # The add-on's optional report issue URL.
- "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
- "description": "A String", # The add-on's optional description.
- "title": "A String", # The add-on's required title.
- "addOnType": "A String", # The add-on's required list of supported container types.
- "helpUrl": "A String", # The add-on's optional help URL.
+ "entryPointType": "A String", # The type of the entry point.
+ "addOn": { # An add-on entry point. # Add-on properties.
+ "title": "A String", # The add-on's required title.
+ "description": "A String", # The add-on's optional description.
+ "reportIssueUrl": "A String", # The add-on's optional report issue URL.
+ "addOnType": "A String", # The add-on's required list of supported container types.
+ "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
+ "helpUrl": "A String", # The add-on's optional help URL.
},
},
],
- "deploymentId": "A String", # The deployment ID for this deployment.
- "updateTime": "A String", # Last modified date time stamp.
- "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
},
}</pre>
</div>
@@ -159,7 +159,7 @@
<pre>Deletes a deployment of an Apps Script project.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
deploymentId: string, The deployment ID to be undeployed. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -186,7 +186,7 @@
<pre>Gets a deployment of an Apps Script project.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
deploymentId: string, The deployment ID. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -197,51 +197,51 @@
An object of the form:
{ # Representation of a single script deployment.
- "entryPoints": [ # The deployment's entry points.
+ "deploymentId": "A String", # The deployment ID for this deployment.
+ "updateTime": "A String", # Last modified date time stamp.
+ "entryPoints": [ # The deployment's entry points.
{ # A configuration that defines how a deployment is accessed externally.
- "entryPointType": "A String", # The type of the entry point.
- "webApp": { # A web application entry point. # An entry point specification for web apps.
- "url": "A String", # The URL for the web application.
- "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
- "executeAs": "A String", # Who to execute the web app as.
- "access": "A String", # Who has permission to run the web app.
+ "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
+ "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the API executable.
},
},
- "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
- "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
- "access": "A String", # Who has permission to run the API executable.
+ "webApp": { # A web application entry point. # An entry point specification for web apps.
+ "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the web app.
+ "executeAs": "A String", # Who to execute the web app as.
},
+ "url": "A String", # The URL for the web application.
},
- "addOn": { # An add-on entry point. # Add-on properties.
- "reportIssueUrl": "A String", # The add-on's optional report issue URL.
- "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
- "description": "A String", # The add-on's optional description.
- "title": "A String", # The add-on's required title.
- "addOnType": "A String", # The add-on's required list of supported container types.
- "helpUrl": "A String", # The add-on's optional help URL.
+ "entryPointType": "A String", # The type of the entry point.
+ "addOn": { # An add-on entry point. # Add-on properties.
+ "title": "A String", # The add-on's required title.
+ "description": "A String", # The add-on's optional description.
+ "reportIssueUrl": "A String", # The add-on's optional report issue URL.
+ "addOnType": "A String", # The add-on's required list of supported container types.
+ "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
+ "helpUrl": "A String", # The add-on's optional help URL.
},
},
],
- "deploymentId": "A String", # The deployment ID for this deployment.
- "updateTime": "A String", # Last modified date time stamp.
- "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
},
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(scriptId, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists the deployments of an Apps Script project.
Args:
- scriptId: string, The script project's Drive ID. (required)
- pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50.
+ scriptId: string, The script project's Drive ID. (required)
pageToken: string, The token for continuing a previous list request on the next page. This
should be set to the value of `nextPageToken` from a previous response.
+ pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -251,45 +251,45 @@
An object of the form:
{ # Response with the list of deployments for the specified Apps Script project.
- "nextPageToken": "A String", # The token that can be used in the next call to get the next page of
- # results.
- "deployments": [ # The list of deployments.
+ "deployments": [ # The list of deployments.
{ # Representation of a single script deployment.
- "entryPoints": [ # The deployment's entry points.
+ "deploymentId": "A String", # The deployment ID for this deployment.
+ "updateTime": "A String", # Last modified date time stamp.
+ "entryPoints": [ # The deployment's entry points.
{ # A configuration that defines how a deployment is accessed externally.
- "entryPointType": "A String", # The type of the entry point.
- "webApp": { # A web application entry point. # An entry point specification for web apps.
- "url": "A String", # The URL for the web application.
- "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
- "executeAs": "A String", # Who to execute the web app as.
- "access": "A String", # Who has permission to run the web app.
+ "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
+ "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the API executable.
},
},
- "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
- "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
- "access": "A String", # Who has permission to run the API executable.
+ "webApp": { # A web application entry point. # An entry point specification for web apps.
+ "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the web app.
+ "executeAs": "A String", # Who to execute the web app as.
},
+ "url": "A String", # The URL for the web application.
},
- "addOn": { # An add-on entry point. # Add-on properties.
- "reportIssueUrl": "A String", # The add-on's optional report issue URL.
- "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
- "description": "A String", # The add-on's optional description.
- "title": "A String", # The add-on's required title.
- "addOnType": "A String", # The add-on's required list of supported container types.
- "helpUrl": "A String", # The add-on's optional help URL.
+ "entryPointType": "A String", # The type of the entry point.
+ "addOn": { # An add-on entry point. # Add-on properties.
+ "title": "A String", # The add-on's required title.
+ "description": "A String", # The add-on's optional description.
+ "reportIssueUrl": "A String", # The add-on's optional report issue URL.
+ "addOnType": "A String", # The add-on's required list of supported container types.
+ "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
+ "helpUrl": "A String", # The add-on's optional help URL.
},
},
],
- "deploymentId": "A String", # The deployment ID for this deployment.
- "updateTime": "A String", # Last modified date time stamp.
- "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
},
},
],
+ "nextPageToken": "A String", # The token that can be used in the next call to get the next page of
+ # results.
}</pre>
</div>
@@ -302,7 +302,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -312,17 +312,17 @@
<pre>Updates a deployment of an Apps Script project.
Args:
- scriptId: string, The script project's Drive ID. (required)
+ scriptId: string, The script project's Drive ID. (required)
deploymentId: string, The deployment ID for this deployment. (required)
body: object, The request body.
The object takes the form of:
{ # Request with deployment information to update an existing deployment.
- "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
},
}
@@ -335,38 +335,38 @@
An object of the form:
{ # Representation of a single script deployment.
- "entryPoints": [ # The deployment's entry points.
+ "deploymentId": "A String", # The deployment ID for this deployment.
+ "updateTime": "A String", # Last modified date time stamp.
+ "entryPoints": [ # The deployment's entry points.
{ # A configuration that defines how a deployment is accessed externally.
- "entryPointType": "A String", # The type of the entry point.
- "webApp": { # A web application entry point. # An entry point specification for web apps.
- "url": "A String", # The URL for the web application.
- "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
- "executeAs": "A String", # Who to execute the web app as.
- "access": "A String", # Who has permission to run the web app.
+ "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
+ "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the API executable.
},
},
- "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
- "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
- "access": "A String", # Who has permission to run the API executable.
+ "webApp": { # A web application entry point. # An entry point specification for web apps.
+ "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
+ "access": "A String", # Who has permission to run the web app.
+ "executeAs": "A String", # Who to execute the web app as.
},
+ "url": "A String", # The URL for the web application.
},
- "addOn": { # An add-on entry point. # Add-on properties.
- "reportIssueUrl": "A String", # The add-on's optional report issue URL.
- "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
- "description": "A String", # The add-on's optional description.
- "title": "A String", # The add-on's required title.
- "addOnType": "A String", # The add-on's required list of supported container types.
- "helpUrl": "A String", # The add-on's optional help URL.
+ "entryPointType": "A String", # The type of the entry point.
+ "addOn": { # An add-on entry point. # Add-on properties.
+ "title": "A String", # The add-on's required title.
+ "description": "A String", # The add-on's optional description.
+ "reportIssueUrl": "A String", # The add-on's optional report issue URL.
+ "addOnType": "A String", # The add-on's required list of supported container types.
+ "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
+ "helpUrl": "A String", # The add-on's optional help URL.
},
},
],
- "deploymentId": "A String", # The deployment ID for this deployment.
- "updateTime": "A String", # Last modified date time stamp.
- "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
- "manifestFileName": "A String", # The manifest file name for this deployment.
- "versionNumber": 42, # The version number on which this deployment is based.
- "scriptId": "A String", # The script project's Drive ID.
- "description": "A String", # The description for this deployment.
+ "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
+ "scriptId": "A String", # The script project's Drive ID.
+ "description": "A String", # The description for this deployment.
+ "manifestFileName": "A String", # The manifest file name for this deployment.
+ "versionNumber": 42, # The version number on which this deployment is based.
},
}</pre>
</div>