GitHubKit 0.12.10__py3-none-any.whl → 0.12.12__py3-none-any.whl

githubkit/versions/v2022_11_28/rest/checks.py

@@ -169,7 +169,21 @@ class ChecksClient:
         ] = UNSET,
         **kwargs,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#create-a-check-run"""
+        """checks/create
+
+        POST /repos/{owner}/{repo}/check-runs
+
+        Creates a new check run for a specific commit in a repository.
+
+        To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
+
+        In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        See also: https://docs.github.com/rest/checks/runs#create-a-check-run
+        """
 
         from typing import Union
 
@@ -299,7 +313,21 @@ class ChecksClient:
         ] = UNSET,
         **kwargs,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#create-a-check-run"""
+        """checks/create
+
+        POST /repos/{owner}/{repo}/check-runs
+
+        Creates a new check run for a specific commit in a repository.
+
+        To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
+
+        In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        See also: https://docs.github.com/rest/checks/runs#create-a-check-run
+        """
 
         from typing import Union
 
@@ -344,7 +372,19 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#get-a-check-run"""
+        """checks/get
+
+        GET /repos/{owner}/{repo}/check-runs/{check_run_id}
+
+        Gets a single check run using its `id`.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#get-a-check-run
+        """
 
         from ..models import CheckRun
 
@@ -367,7 +407,19 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#get-a-check-run"""
+        """checks/get
+
+        GET /repos/{owner}/{repo}/check-runs/{check_run_id}
+
+        Gets a single check run using its `id`.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#get-a-check-run
+        """
 
         from ..models import CheckRun
 
@@ -479,7 +531,19 @@ class ChecksClient:
         ] = UNSET,
         **kwargs,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#update-a-check-run"""
+        """checks/update
+
+        PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}
+
+        Updates a check run for a specific commit in a repository.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth apps and personal access tokens (classic) cannot use this endpoint.
+
+        See also: https://docs.github.com/rest/checks/runs#update-a-check-run
+        """
 
         from typing import Union
 
@@ -613,7 +677,19 @@ class ChecksClient:
         ] = UNSET,
         **kwargs,
     ) -> Response[CheckRun, CheckRunType]:
-        """See also: https://docs.github.com/rest/checks/runs#update-a-check-run"""
+        """checks/update
+
+        PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}
+
+        Updates a check run for a specific commit in a repository.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth apps and personal access tokens (classic) cannot use this endpoint.
+
+        See also: https://docs.github.com/rest/checks/runs#update-a-check-run
+        """
 
         from typing import Union
 
@@ -660,7 +736,16 @@ class ChecksClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[CheckAnnotation], list[CheckAnnotationType]]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-run-annotations"""
+        """checks/list-annotations
+
+        GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
+
+        Lists annotations for a check run using the annotation `id`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-run-annotations
+        """
 
         from ..models import CheckAnnotation
 
@@ -691,7 +776,16 @@ class ChecksClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[CheckAnnotation], list[CheckAnnotationType]]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-run-annotations"""
+        """checks/list-annotations
+
+        GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
+
+        Lists annotations for a check run using the annotation `id`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-run-annotations
+        """
 
         from ..models import CheckAnnotation
 
@@ -720,7 +814,16 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[EmptyObject, EmptyObjectType]:
-        """See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run"""
+        """checks/rerequest-run
+
+        POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
+
+        Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.
+
+        For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+
+        See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
+        """
 
         from ..models import BasicError, EmptyObject
 
@@ -748,7 +851,16 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[EmptyObject, EmptyObjectType]:
-        """See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run"""
+        """checks/rerequest-run
+
+        POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
+
+        Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.
+
+        For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+
+        See also: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
+        """
 
         from ..models import BasicError, EmptyObject
 
@@ -798,7 +910,19 @@ class ChecksClient:
         data: Missing[ReposOwnerRepoCheckSuitesPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[CheckSuite, CheckSuiteType]:
-        """See also: https://docs.github.com/rest/checks/suites#create-a-check-suite"""
+        """checks/create-suite
+
+        POST /repos/{owner}/{repo}/check-suites
+
+        Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth apps and personal access tokens (classic) cannot use this endpoint.
+
+        See also: https://docs.github.com/rest/checks/suites#create-a-check-suite
+        """
 
         from ..models import CheckSuite, ReposOwnerRepoCheckSuitesPostBody
 
@@ -853,7 +977,19 @@ class ChecksClient:
         data: Missing[ReposOwnerRepoCheckSuitesPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[CheckSuite, CheckSuiteType]:
-        """See also: https://docs.github.com/rest/checks/suites#create-a-check-suite"""
+        """checks/create-suite
+
+        POST /repos/{owner}/{repo}/check-suites
+
+        Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth apps and personal access tokens (classic) cannot use this endpoint.
+
+        See also: https://docs.github.com/rest/checks/suites#create-a-check-suite
+        """
 
         from ..models import CheckSuite, ReposOwnerRepoCheckSuitesPostBody
 
@@ -912,7 +1048,15 @@ class ChecksClient:
         data: Missing[ReposOwnerRepoCheckSuitesPreferencesPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[CheckSuitePreference, CheckSuitePreferenceType]:
-        """See also: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites"""
+        """checks/set-suites-preferences
+
+        PATCH /repos/{owner}/{repo}/check-suites/preferences
+
+        Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+        You must have admin permissions in the repository to set preferences for check suites.
+
+        See also: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
+        """
 
         from ..models import (
             CheckSuitePreference,
@@ -976,7 +1120,15 @@ class ChecksClient:
         data: Missing[ReposOwnerRepoCheckSuitesPreferencesPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[CheckSuitePreference, CheckSuitePreferenceType]:
-        """See also: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites"""
+        """checks/set-suites-preferences
+
+        PATCH /repos/{owner}/{repo}/check-suites/preferences
+
+        Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+        You must have admin permissions in the repository to set preferences for check suites.
+
+        See also: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
+        """
 
         from ..models import (
             CheckSuitePreference,
@@ -1014,7 +1166,19 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[CheckSuite, CheckSuiteType]:
-        """See also: https://docs.github.com/rest/checks/suites#get-a-check-suite"""
+        """checks/get-suite
+
+        GET /repos/{owner}/{repo}/check-suites/{check_suite_id}
+
+        Gets a single check suite using its `id`.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/suites#get-a-check-suite
+        """
 
         from ..models import CheckSuite
 
@@ -1037,7 +1201,19 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[CheckSuite, CheckSuiteType]:
-        """See also: https://docs.github.com/rest/checks/suites#get-a-check-suite"""
+        """checks/get-suite
+
+        GET /repos/{owner}/{repo}/check-suites/{check_suite_id}
+
+        Gets a single check suite using its `id`.
+
+        > [!NOTE]
+        > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/suites#get-a-check-suite
+        """
 
         from ..models import CheckSuite
 
@@ -1068,7 +1244,19 @@ class ChecksClient:
         ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200,
         ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite"""
+        """checks/list-for-suite
+
+        GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
+
+        Lists check runs for a check suite using its `id`.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
+        """
 
         from ..models import (
             ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200,
@@ -1110,7 +1298,19 @@ class ChecksClient:
         ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200,
         ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite"""
+        """checks/list-for-suite
+
+        GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
+
+        Lists check runs for a check suite using its `id`.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
+        """
 
         from ..models import (
             ReposOwnerRepoCheckSuitesCheckSuiteIdCheckRunsGetResponse200,
@@ -1144,7 +1344,14 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[EmptyObject, EmptyObjectType]:
-        """See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite"""
+        """checks/rerequest-suite
+
+        POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
+
+        Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+
+        See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
+        """
 
         from ..models import EmptyObject
 
@@ -1167,7 +1374,14 @@ class ChecksClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[EmptyObject, EmptyObjectType]:
-        """See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite"""
+        """checks/rerequest-suite
+
+        POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest
+
+        Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+
+        See also: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
+        """
 
         from ..models import EmptyObject
 
@@ -1199,7 +1413,21 @@ class ChecksClient:
         ReposOwnerRepoCommitsRefCheckRunsGetResponse200,
         ReposOwnerRepoCommitsRefCheckRunsGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference"""
+        """checks/list-for-ref
+
+        GET /repos/{owner}/{repo}/commits/{ref}/check-runs
+
+        Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
+        """
 
         from ..models import ReposOwnerRepoCommitsRefCheckRunsGetResponse200
 
@@ -1241,7 +1469,21 @@ class ChecksClient:
         ReposOwnerRepoCommitsRefCheckRunsGetResponse200,
         ReposOwnerRepoCommitsRefCheckRunsGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference"""
+        """checks/list-for-ref
+
+        GET /repos/{owner}/{repo}/commits/{ref}/check-runs
+
+        Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+
+        If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
+        """
 
         from ..models import ReposOwnerRepoCommitsRefCheckRunsGetResponse200
 
@@ -1281,7 +1523,19 @@ class ChecksClient:
         ReposOwnerRepoCommitsRefCheckSuitesGetResponse200,
         ReposOwnerRepoCommitsRefCheckSuitesGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference"""
+        """checks/list-suites-for-ref
+
+        GET /repos/{owner}/{repo}/commits/{ref}/check-suites
+
+        Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
+        """
 
         from ..models import ReposOwnerRepoCommitsRefCheckSuitesGetResponse200
 
@@ -1319,7 +1573,19 @@ class ChecksClient:
         ReposOwnerRepoCommitsRefCheckSuitesGetResponse200,
         ReposOwnerRepoCommitsRefCheckSuitesGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference"""
+        """checks/list-suites-for-ref
+
+        GET /repos/{owner}/{repo}/commits/{ref}/check-suites
+
+        Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
+
+        > [!NOTE]
+        > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+
+        See also: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
+        """
 
         from ..models import ReposOwnerRepoCommitsRefCheckSuitesGetResponse200
 

githubkit/versions/v2022_11_28/rest/classroom.py

@@ -61,7 +61,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[ClassroomAssignment, ClassroomAssignmentType]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-an-assignment"""
+        """classroom/get-an-assignment
+
+        GET /assignments/{assignment_id}
+
+        Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-an-assignment
+        """
 
         from ..models import BasicError, ClassroomAssignment
 
@@ -85,7 +92,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[ClassroomAssignment, ClassroomAssignmentType]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-an-assignment"""
+        """classroom/get-an-assignment
+
+        GET /assignments/{assignment_id}
+
+        Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-an-assignment
+        """
 
         from ..models import BasicError, ClassroomAssignment
 
@@ -113,7 +127,14 @@ class ClassroomClient:
     ) -> Response[
         list[ClassroomAcceptedAssignment], list[ClassroomAcceptedAssignmentType]
     ]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment"""
+        """classroom/list-accepted-assignments-for-an-assignment
+
+        GET /assignments/{assignment_id}/accepted_assignments
+
+        Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
+        """
 
         from ..models import ClassroomAcceptedAssignment
 
@@ -144,7 +165,14 @@ class ClassroomClient:
     ) -> Response[
         list[ClassroomAcceptedAssignment], list[ClassroomAcceptedAssignmentType]
     ]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment"""
+        """classroom/list-accepted-assignments-for-an-assignment
+
+        GET /assignments/{assignment_id}/accepted_assignments
+
+        Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
+        """
 
         from ..models import ClassroomAcceptedAssignment
 
@@ -171,7 +199,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[ClassroomAssignmentGrade], list[ClassroomAssignmentGradeType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-assignment-grades"""
+        """classroom/get-assignment-grades
+
+        GET /assignments/{assignment_id}/grades
+
+        Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-assignment-grades
+        """
 
         from ..models import BasicError, ClassroomAssignmentGrade
 
@@ -195,7 +230,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[ClassroomAssignmentGrade], list[ClassroomAssignmentGradeType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-assignment-grades"""
+        """classroom/get-assignment-grades
+
+        GET /assignments/{assignment_id}/grades
+
+        Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-assignment-grades
+        """
 
         from ..models import BasicError, ClassroomAssignmentGrade
 
@@ -220,7 +262,14 @@ class ClassroomClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleClassroom], list[SimpleClassroomType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-classrooms"""
+        """classroom/list-classrooms
+
+        GET /classrooms
+
+        Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-classrooms
+        """
 
         from ..models import SimpleClassroom
 
@@ -248,7 +297,14 @@ class ClassroomClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleClassroom], list[SimpleClassroomType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-classrooms"""
+        """classroom/list-classrooms
+
+        GET /classrooms
+
+        Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-classrooms
+        """
 
         from ..models import SimpleClassroom
 
@@ -275,7 +331,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Classroom, ClassroomType]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-a-classroom"""
+        """classroom/get-a-classroom
+
+        GET /classrooms/{classroom_id}
+
+        Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-a-classroom
+        """
 
         from ..models import BasicError, Classroom
 
@@ -299,7 +362,14 @@ class ClassroomClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Classroom, ClassroomType]:
-        """See also: https://docs.github.com/rest/classroom/classroom#get-a-classroom"""
+        """classroom/get-a-classroom
+
+        GET /classrooms/{classroom_id}
+
+        Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+
+        See also: https://docs.github.com/rest/classroom/classroom#get-a-classroom
+        """
 
         from ..models import BasicError, Classroom
 
@@ -325,7 +395,14 @@ class ClassroomClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleClassroomAssignment], list[SimpleClassroomAssignmentType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom"""
+        """classroom/list-assignments-for-a-classroom
+
+        GET /classrooms/{classroom_id}/assignments
+
+        Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
+        """
 
         from ..models import SimpleClassroomAssignment
 
@@ -354,7 +431,14 @@ class ClassroomClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleClassroomAssignment], list[SimpleClassroomAssignmentType]]:
-        """See also: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom"""
+        """classroom/list-assignments-for-a-classroom
+
+        GET /classrooms/{classroom_id}/assignments
+
+        Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+
+        See also: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
+        """
 
         from ..models import SimpleClassroomAssignment