Skip to content

Commit

Permalink
Update OpenAPI 3.1 Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Feb 28, 2025
1 parent 6eb4013 commit d4c4bc7
Show file tree
Hide file tree
Showing 16 changed files with 608 additions and 480 deletions.
60 changes: 36 additions & 24 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23905,7 +23905,7 @@
"/orgs/{org}/teams/{team_slug}/projects": {
"get": {
"summary": "List team projects",
"description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -23957,14 +23957,17 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "teams"
}
"subcategory": "teams",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
}
},
"/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
"get": {
"summary": "Check team permissions for a project",
"description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -24008,12 +24011,15 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "teams"
}
"subcategory": "teams",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
},
"put": {
"summary": "Add or update team project permissions",
"description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -24100,12 +24106,15 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "teams"
}
"subcategory": "teams",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
},
"delete": {
"summary": "Remove a project from a team",
"description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -24134,8 +24143,11 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "teams"
}
"subcategory": "teams",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
}
},
"/orgs/{org}/teams/{team_slug}/repos": {
Expand Down Expand Up @@ -61673,7 +61685,7 @@
"/teams/{team_id}/projects": {
"get": {
"summary": "List team projects (Legacy)",
"description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -61724,8 +61736,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"removalDate": "2025-04-01",
"deprecationDate": "2024-05-23",
"category": "teams",
"subcategory": "teams"
},
Expand All @@ -61735,7 +61747,7 @@
"/teams/{team_id}/projects/{project_id}": {
"get": {
"summary": "Check team permissions for a project (Legacy)",
"description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -61775,16 +61787,16 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"removalDate": "2025-04-01",
"deprecationDate": "2024-05-23",
"category": "teams",
"subcategory": "teams"
},
"deprecated": true
},
"put": {
"summary": "Add or update team project permissions (Legacy)",
"description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -61870,16 +61882,16 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"removalDate": "2025-04-01",
"deprecationDate": "2024-05-23",
"category": "teams",
"subcategory": "teams"
},
"deprecated": true
},
"delete": {
"summary": "Remove a project from a team (Legacy)",
"description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
Expand Down Expand Up @@ -61910,8 +61922,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"removalDate": "2025-04-01",
"deprecationDate": "2024-05-23",
"category": "teams",
"subcategory": "teams"
},
Expand Down
76 changes: 40 additions & 36 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17363,10 +17363,9 @@ paths:
get:
summary: List team projects
description: |-
Lists the organization projects for a team.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.
> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/list-projects-in-org
Expand Down Expand Up @@ -17398,14 +17397,16 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
"/orgs/{org}/teams/{team_slug}/projects/{project_id}":
get:
summary: Check team permissions for a project
description: |-
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.
> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/check-permissions-for-project-in-org
Expand Down Expand Up @@ -17433,13 +17434,15 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
put:
summary: Add or update team project permissions
description: |-
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.
> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/add-or-update-project-permissions-in-org
Expand Down Expand Up @@ -17500,13 +17503,15 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
delete:
summary: Remove a project from a team
description: |-
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.
> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/remove-project-in-org
Expand All @@ -17525,6 +17530,9 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
deprecationDate: '2024-05-23'
removalDate: '2025-04-01'
deprecated: true
"/orgs/{org}/teams/{team_slug}/repos":
get:
summary: List team repositories
Expand Down Expand Up @@ -44841,9 +44849,8 @@ paths:
summary: List team projects (Legacy)
description: |-
> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.

Lists the organization projects for a team.
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/list-projects-legacy
Expand Down Expand Up @@ -44874,8 +44881,8 @@ paths:
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
removalDate: '2025-04-01'
deprecationDate: '2024-05-23'
category: teams
subcategory: teams
deprecated: true
Expand All @@ -44884,9 +44891,8 @@ paths:
summary: Check team permissions for a project (Legacy)
description: |-
> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.

Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/check-permissions-for-project-legacy
Expand All @@ -44911,18 +44917,17 @@ paths:
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
removalDate: '2025-04-01'
deprecationDate: '2024-05-23'
category: teams
subcategory: teams
deprecated: true
put:
summary: Add or update team project permissions (Legacy)
description: |-
> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/add-or-update-project-permissions-legacy
Expand Down Expand Up @@ -44982,18 +44987,17 @@ paths:
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
removalDate: '2025-04-01'
deprecationDate: '2024-05-23'
category: teams
subcategory: teams
deprecated: true
delete:
summary: Remove a project from a team (Legacy)
description: |-
> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
tags:
- teams
operationId: teams/remove-project-legacy
Expand All @@ -45013,8 +45017,8 @@ paths:
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
removalDate: '2025-04-01'
deprecationDate: '2024-05-23'
category: teams
subcategory: teams
deprecated: true
Expand Down
Loading

0 comments on commit d4c4bc7

Please sign in to comment.