docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/classroom_v1.courses.aliases.html b/docs/dyn/classroom_v1.courses.aliases.html
index 82da446..791d9cd 100644
--- a/docs/dyn/classroom_v1.courses.aliases.html
+++ b/docs/dyn/classroom_v1.courses.aliases.html
@@ -75,62 +75,37 @@
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.aliases.html">aliases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an alias for a course.</p>
+<p class="firstline">Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).</p>
<p class="toc_element">
<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="firstline">Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).</p>
<p class="toc_element">
<code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a list of aliases for a course.</p>
+<p class="firstline">Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
- <pre>Creates an alias for a course.
-
-This method returns the following error codes:
-
-* `PERMISSION_DENIED` if the requesting user is not permitted to create the
-alias or for access errors.
-* `NOT_FOUND` if the course does not exist.
-* `ALREADY_EXISTS` if the alias already exists.
-* `FAILED_PRECONDITION` if the alias requested does not make sense for the
- requesting user or course (for example, if a user not in a domain
- attempts to access a domain-scoped alias).
+ <pre>Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
Args:
- courseId: string, Identifier of the course to alias.
-This identifier can be either the Classroom-assigned identifier or an
-alias. (required)
+ courseId: string, Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. (required)
body: object, The request body.
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.
- #
- # * `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.
+{ # 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. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
}
x__xgafv: string, V1 error format.
@@ -141,51 +116,18 @@
Returns:
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.
- #
- # * `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.
+ { # 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. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, alias, x__xgafv=None)</code>
- <pre>Deletes an alias of a course.
-
-This method returns the following error codes:
-
-* `PERMISSION_DENIED` if the requesting user is not permitted to remove the
-alias or for access errors.
-* `NOT_FOUND` if the alias does not exist.
-* `FAILED_PRECONDITION` if the alias requested does not make sense for the
- requesting user or course (for example, if a user not in a domain
- attempts to delete a domain-scoped alias).
+ <pre>Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
Args:
- courseId: string, Identifier of the course whose alias should be deleted.
-This identifier can be either the Classroom-assigned identifier or an
-alias. (required)
- alias: string, Alias to delete.
-This may not be the Classroom-assigned identifier. (required)
+ courseId: string, Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ alias: string, Alias to delete. This may not be the Classroom-assigned identifier. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -194,43 +136,18 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Returns a list of aliases for a course.
-
-This method returns the following error codes:
-
-* `PERMISSION_DENIED` if the requesting user is not permitted to access the
-course or for access errors.
-* `NOT_FOUND` if the course does not exist.
+ <pre>Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
Args:
- 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,
-indicating that the subsequent page of results should be returned.
-
-The list request
-must be otherwise identical to the one that resulted in this token.
+ 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, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -241,33 +158,11 @@
{ # Response when listing 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.
- #
- # * `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.
+ { # 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. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` 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.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>