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/classroom_v1.courses.aliases.html b/docs/dyn/classroom_v1.courses.aliases.html
index 057c312..b5286b1 100644
--- a/docs/dyn/classroom_v1.courses.aliases.html
+++ b/docs/dyn/classroom_v1.courses.aliases.html
@@ -81,7 +81,7 @@
<code><a href="#delete">delete(courseId, alias, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an alias of a course.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of aliases for a course.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -109,29 +109,29 @@
The object takes the form of:
{ # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
#
- # An alias uniquely identifies a course. It must be unique within one of the
- # following scopes:
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
#
- # * domain: A domain-scoped alias is visible to all users within the alias
- # creator's domain and can be created only by a domain admin. A domain-scoped
- # alias is often used when a course has an identifier external to Classroom.
- #
- # * project: A project-scoped alias is visible to any request from an
- # application using the Developer Console project ID that created the alias
- # and can be created by any project. A project-scoped alias is often used when
- # an application has alternative identifiers. A random value can also be used
- # to avoid duplicate courses in the event of transmission failures, as retrying
- # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
- #
- # * `d:<name>` indicates a domain-scoped alias.
- # Example: `d:math_101`
- # * `p:<name>` indicates a project-scoped alias.
- # Example: `p:abc123`
- #
- # This field has a maximum length of 256 characters.
- }
+ # This field has a maximum length of 256 characters.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -142,29 +142,29 @@
An object of the form:
{ # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
#
- # An alias uniquely identifies a course. It must be unique within one of the
- # following scopes:
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
#
- # * domain: A domain-scoped alias is visible to all users within the alias
- # creator's domain and can be created only by a domain admin. A domain-scoped
- # alias is often used when a course has an identifier external to Classroom.
- #
- # * project: A project-scoped alias is visible to any request from an
- # application using the Developer Console project ID that created the alias
- # and can be created by any project. A project-scoped alias is often used when
- # an application has alternative identifiers. A random value can also be used
- # to avoid duplicate courses in the event of transmission failures, as retrying
- # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
- #
- # * `d:<name>` indicates a domain-scoped alias.
- # Example: `d:math_101`
- # * `p:<name>` indicates a project-scoped alias.
- # Example: `p:abc123`
- #
- # This field has a maximum length of 256 characters.
- }</pre>
+ # This field has a maximum length of 256 characters.
+ }</pre>
</div>
<div class="method">
@@ -207,7 +207,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns a list of aliases for a course.
This method returns the following error codes:
@@ -220,10 +220,6 @@
courseId: string, The identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
- pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
-server may assign a maximum.
-
-The server may return fewer than the specified number of results.
pageToken: string, nextPageToken
value returned from a previous
list call,
@@ -231,6 +227,10 @@
The list request
must be otherwise identical to the one that resulted in this token.
+ pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
+server may assign a maximum.
+
+The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -240,34 +240,34 @@
An object of the form:
{ # Response when listing course aliases.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
- # results are available.
- "aliases": [ # The course aliases.
+ "aliases": [ # The course aliases.
{ # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
#
- # An alias uniquely identifies a course. It must be unique within one of the
- # following scopes:
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
#
- # * domain: A domain-scoped alias is visible to all users within the alias
- # creator's domain and can be created only by a domain admin. A domain-scoped
- # alias is often used when a course has an identifier external to Classroom.
- #
- # * project: A project-scoped alias is visible to any request from an
- # application using the Developer Console project ID that created the alias
- # and can be created by any project. A project-scoped alias is often used when
- # an application has alternative identifiers. A random value can also be used
- # to avoid duplicate courses in the event of transmission failures, as retrying
- # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
- #
- # * `d:<name>` indicates a domain-scoped alias.
- # Example: `d:math_101`
- # * `p:<name>` indicates a project-scoped alias.
- # Example: `p:abc123`
- #
- # This field has a maximum length of 256 characters.
- },
+ # This field has a maximum length of 256 characters.
+ },
],
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
}</pre>
</div>
@@ -280,7 +280,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>