diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 930f0f29e2..c276f024e1 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -4851,15 +4851,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4889,21 +4889,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4939,21 +4942,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -4986,21 +4992,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5033,21 +5042,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5077,21 +5089,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5127,8 +5142,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -114708,7 +114726,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 2397d0499c..aee25d0e3d 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -3696,15 +3696,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3723,19 +3727,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3756,18 +3765,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3788,18 +3803,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3819,18 +3840,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: 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. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3849,18 +3876,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3881,6 +3914,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -83369,7 +83405,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index a9a0cd9bae..b7a21c1048 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -4851,15 +4851,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4889,21 +4889,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4939,21 +4942,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -4986,21 +4992,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5033,21 +5042,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5077,21 +5089,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5127,8 +5142,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -114559,7 +114577,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 8c5c7e5837..168b6d79a6 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -3696,15 +3696,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3723,19 +3727,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3756,18 +3765,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3788,18 +3803,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3819,18 +3840,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: 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. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3849,18 +3876,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3881,6 +3914,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -83244,7 +83280,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 7e98864f30..aea2b92b28 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -4865,15 +4865,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4903,21 +4903,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4953,21 +4956,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -5000,21 +5006,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5047,21 +5056,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5091,21 +5103,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5141,8 +5156,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -115191,7 +115209,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index dbf873b6e2..dc2407d753 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -3704,15 +3704,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3731,19 +3735,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3764,18 +3773,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3796,18 +3811,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3827,18 +3848,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: 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. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3857,18 +3884,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3889,6 +3922,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -83659,7 +83695,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 208209c870..73fcd69cba 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -7888,7 +7888,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -8890,7 +8890,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9746,7 +9746,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10233,7 +10233,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12290,7 +12290,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13343,7 +13343,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14313,7 +14313,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14994,7 +14994,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16314,15 +16314,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16651,21 +16651,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -17034,21 +17037,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17197,21 +17203,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17291,21 +17300,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17449,21 +17461,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17689,8 +17704,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -148201,7 +148219,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -149218,7 +149236,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -384821,7 +384839,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -641332,7 +641350,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -721485,7 +721503,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -914874,7 +914892,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -917497,7 +917515,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -920027,7 +920045,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -922557,7 +922575,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -925219,7 +925237,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -927888,7 +927906,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -932194,7 +932212,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 129071cbeb..476fec1fd3 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -4736,7 +4736,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6697,15 +6698,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -6954,19 +6959,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7218,18 +7228,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7319,18 +7335,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7353,18 +7375,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: 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. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - &35 name: classroom_id @@ -7398,18 +7426,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - *35 - *19 @@ -7451,6 +7485,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 4df8dd2e5e..583fbb6755 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -7824,7 +7824,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -8826,7 +8826,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9682,7 +9682,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10169,7 +10169,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12209,7 +12209,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13262,7 +13262,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14232,7 +14232,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14913,7 +14913,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16233,15 +16233,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16570,21 +16570,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -16953,21 +16956,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17116,21 +17122,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17210,21 +17219,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17368,21 +17380,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17608,8 +17623,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -144436,7 +144454,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -145453,7 +145471,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -378076,7 +378094,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -630157,7 +630175,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -707385,7 +707403,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -898741,7 +898759,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -901352,7 +901370,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -903870,7 +903888,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -906388,7 +906406,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -909038,7 +909056,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -911695,7 +911713,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -915977,7 +915995,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index b2b64b1096..5841788a9f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -4704,7 +4704,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6649,15 +6650,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -6906,19 +6911,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7170,18 +7180,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7271,18 +7287,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7305,18 +7327,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: 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. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - &35 name: classroom_id @@ -7350,18 +7378,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - *35 - *19 @@ -7403,6 +7437,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 979d5f4958..3736118526 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -8012,7 +8012,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9014,7 +9014,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9884,7 +9884,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10371,7 +10371,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12531,7 +12531,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13584,7 +13584,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14554,7 +14554,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -15235,7 +15235,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16555,15 +16555,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16892,21 +16892,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "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.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -17275,21 +17278,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "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.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets 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.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17438,21 +17444,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "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.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists 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.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17532,21 +17541,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "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.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17690,21 +17702,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17930,8 +17945,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -150756,7 +150774,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -151773,7 +151791,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -393588,7 +393606,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -656831,7 +656849,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -741718,7 +741736,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -938516,7 +938534,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -941164,7 +941182,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -943719,7 +943737,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -946274,7 +946292,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -948961,7 +948979,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -951655,7 +951673,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -956011,7 +956029,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 0a76619a5d..f98c1d0c85 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -4793,7 +4793,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6851,15 +6852,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -7108,19 +7113,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: 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. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7372,18 +7382,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: 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. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7473,18 +7489,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: 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. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + 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. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7507,18 +7529,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom cla{"code":"deadline_exceeded","msg":"operation timed out"}