Skip to content

Commit d4c4bc7

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 6eb4013 commit d4c4bc7

16 files changed

+608
-480
lines changed

‎descriptions-next/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23905,7 +23905,7 @@
2390523905
"/orgs/{org}/teams/{team_slug}/projects": {
2390623906
"get": {
2390723907
"summary": "List team projects",
23908-
"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`.",
23908+
"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.",
2390923909
"tags": [
2391023910
"teams"
2391123911
],
@@ -23957,14 +23957,17 @@
2395723957
"githubCloudOnly": false,
2395823958
"enabledForGitHubApps": true,
2395923959
"category": "teams",
23960-
"subcategory": "teams"
23961-
}
23960+
"subcategory": "teams",
23961+
"deprecationDate": "2024-05-23",
23962+
"removalDate": "2025-04-01"
23963+
},
23964+
"deprecated": true
2396223965
}
2396323966
},
2396423967
"/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
2396523968
"get": {
2396623969
"summary": "Check team permissions for a project",
23967-
"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}`.",
23970+
"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.",
2396823971
"tags": [
2396923972
"teams"
2397023973
],
@@ -24008,12 +24011,15 @@
2400824011
"githubCloudOnly": false,
2400924012
"enabledForGitHubApps": true,
2401024013
"category": "teams",
24011-
"subcategory": "teams"
24012-
}
24014+
"subcategory": "teams",
24015+
"deprecationDate": "2024-05-23",
24016+
"removalDate": "2025-04-01"
24017+
},
24018+
"deprecated": true
2401324019
},
2401424020
"put": {
2401524021
"summary": "Add or update team project permissions",
24016-
"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}`.",
24022+
"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.",
2401724023
"tags": [
2401824024
"teams"
2401924025
],
@@ -24100,12 +24106,15 @@
2410024106
"githubCloudOnly": false,
2410124107
"enabledForGitHubApps": true,
2410224108
"category": "teams",
24103-
"subcategory": "teams"
24104-
}
24109+
"subcategory": "teams",
24110+
"deprecationDate": "2024-05-23",
24111+
"removalDate": "2025-04-01"
24112+
},
24113+
"deprecated": true
2410524114
},
2410624115
"delete": {
2410724116
"summary": "Remove a project from a team",
24108-
"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}`.",
24117+
"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.",
2410924118
"tags": [
2411024119
"teams"
2411124120
],
@@ -24134,8 +24143,11 @@
2413424143
"githubCloudOnly": false,
2413524144
"enabledForGitHubApps": true,
2413624145
"category": "teams",
24137-
"subcategory": "teams"
24138-
}
24146+
"subcategory": "teams",
24147+
"deprecationDate": "2024-05-23",
24148+
"removalDate": "2025-04-01"
24149+
},
24150+
"deprecated": true
2413924151
}
2414024152
},
2414124153
"/orgs/{org}/teams/{team_slug}/repos": {
@@ -61673,7 +61685,7 @@
6167361685
"/teams/{team_id}/projects": {
6167461686
"get": {
6167561687
"summary": "List team projects (Legacy)",
61676-
"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.",
61688+
"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.",
6167761689
"tags": [
6167861690
"teams"
6167961691
],
@@ -61724,8 +61736,8 @@
6172461736
"x-github": {
6172561737
"githubCloudOnly": false,
6172661738
"enabledForGitHubApps": true,
61727-
"removalDate": "2021-02-01",
61728-
"deprecationDate": "2020-01-21",
61739+
"removalDate": "2025-04-01",
61740+
"deprecationDate": "2024-05-23",
6172961741
"category": "teams",
6173061742
"subcategory": "teams"
6173161743
},
@@ -61735,7 +61747,7 @@
6173561747
"/teams/{team_id}/projects/{project_id}": {
6173661748
"get": {
6173761749
"summary": "Check team permissions for a project (Legacy)",
61738-
"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.",
61750+
"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.",
6173961751
"tags": [
6174061752
"teams"
6174161753
],
@@ -61775,16 +61787,16 @@
6177561787
"x-github": {
6177661788
"githubCloudOnly": false,
6177761789
"enabledForGitHubApps": true,
61778-
"removalDate": "2021-02-01",
61779-
"deprecationDate": "2020-01-21",
61790+
"removalDate": "2025-04-01",
61791+
"deprecationDate": "2024-05-23",
6178061792
"category": "teams",
6178161793
"subcategory": "teams"
6178261794
},
6178361795
"deprecated": true
6178461796
},
6178561797
"put": {
6178661798
"summary": "Add or update team project permissions (Legacy)",
61787-
"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.",
61799+
"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.",
6178861800
"tags": [
6178961801
"teams"
6179061802
],
@@ -61870,16 +61882,16 @@
6187061882
"x-github": {
6187161883
"githubCloudOnly": false,
6187261884
"enabledForGitHubApps": true,
61873-
"removalDate": "2021-02-01",
61874-
"deprecationDate": "2020-01-21",
61885+
"removalDate": "2025-04-01",
61886+
"deprecationDate": "2024-05-23",
6187561887
"category": "teams",
6187661888
"subcategory": "teams"
6187761889
},
6187861890
"deprecated": true
6187961891
},
6188061892
"delete": {
6188161893
"summary": "Remove a project from a team (Legacy)",
61882-
"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.",
61894+
"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.",
6188361895
"tags": [
6188461896
"teams"
6188561897
],
@@ -61910,8 +61922,8 @@
6191061922
"x-github": {
6191161923
"githubCloudOnly": false,
6191261924
"enabledForGitHubApps": true,
61913-
"removalDate": "2021-02-01",
61914-
"deprecationDate": "2020-01-21",
61925+
"removalDate": "2025-04-01",
61926+
"deprecationDate": "2024-05-23",
6191561927
"category": "teams",
6191661928
"subcategory": "teams"
6191761929
},

‎descriptions-next/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17363,10 +17363,9 @@ paths:
1736317363
get:
1736417364
summary: List team projects
1736517365
description: |-
17366-
Lists the organization projects for a team.
17367-
17368-
> [!NOTE]
17369-
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.
17366+
> [!WARNING]
17367+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17368+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1737017369
tags:
1737117370
- teams
1737217371
operationId: teams/list-projects-in-org
@@ -17398,14 +17397,16 @@ paths:
1739817397
enabledForGitHubApps: true
1739917398
category: teams
1740017399
subcategory: teams
17400+
deprecationDate: '2024-05-23'
17401+
removalDate: '2025-04-01'
17402+
deprecated: true
1740117403
"/orgs/{org}/teams/{team_slug}/projects/{project_id}":
1740217404
get:
1740317405
summary: Check team permissions for a project
1740417406
description: |-
17405-
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
17406-
17407-
> [!NOTE]
17408-
> 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}`.
17407+
> [!WARNING]
17408+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17409+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1740917410
tags:
1741017411
- teams
1741117412
operationId: teams/check-permissions-for-project-in-org
@@ -17433,13 +17434,15 @@ paths:
1743317434
enabledForGitHubApps: true
1743417435
category: teams
1743517436
subcategory: teams
17437+
deprecationDate: '2024-05-23'
17438+
removalDate: '2025-04-01'
17439+
deprecated: true
1743617440
put:
1743717441
summary: Add or update team project permissions
1743817442
description: |-
17439-
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.
17440-
17441-
> [!NOTE]
17442-
> 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}`.
17443+
> [!WARNING]
17444+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17445+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1744317446
tags:
1744417447
- teams
1744517448
operationId: teams/add-or-update-project-permissions-in-org
@@ -17500,13 +17503,15 @@ paths:
1750017503
enabledForGitHubApps: true
1750117504
category: teams
1750217505
subcategory: teams
17506+
deprecationDate: '2024-05-23'
17507+
removalDate: '2025-04-01'
17508+
deprecated: true
1750317509
delete:
1750417510
summary: Remove a project from a team
1750517511
description: |-
17506-
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.
17507-
17508-
> [!NOTE]
17509-
> 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}`.
17512+
> [!WARNING]
17513+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17514+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1751017515
tags:
1751117516
- teams
1751217517
operationId: teams/remove-project-in-org
@@ -17525,6 +17530,9 @@ paths:
1752517530
enabledForGitHubApps: true
1752617531
category: teams
1752717532
subcategory: teams
17533+
deprecationDate: '2024-05-23'
17534+
removalDate: '2025-04-01'
17535+
deprecated: true
1752817536
"/orgs/{org}/teams/{team_slug}/repos":
1752917537
get:
1753017538
summary: List team repositories
@@ -44841,9 +44849,8 @@ paths:
4484144849
summary: List team projects (Legacy)
4484244850
description: |-
4484344851
> [!WARNING]
44844-
> **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.
44845-
44846-
Lists the organization projects for a team.
44852+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44853+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4484744854
tags:
4484844855
- teams
4484944856
operationId: teams/list-projects-legacy
@@ -44874,8 +44881,8 @@ paths:
4487444881
x-github:
4487544882
githubCloudOnly: false
4487644883
enabledForGitHubApps: true
44877-
removalDate: '2021-02-01'
44878-
deprecationDate: '2020-01-21'
44884+
removalDate: '2025-04-01'
44885+
deprecationDate: '2024-05-23'
4487944886
category: teams
4488044887
subcategory: teams
4488144888
deprecated: true
@@ -44884,9 +44891,8 @@ paths:
4488444891
summary: Check team permissions for a project (Legacy)
4488544892
description: |-
4488644893
> [!WARNING]
44887-
> **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.
44888-
44889-
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
44894+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44895+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4489044896
tags:
4489144897
- teams
4489244898
operationId: teams/check-permissions-for-project-legacy
@@ -44911,18 +44917,17 @@ paths:
4491144917
x-github:
4491244918
githubCloudOnly: false
4491344919
enabledForGitHubApps: true
44914-
removalDate: '2021-02-01'
44915-
deprecationDate: '2020-01-21'
44920+
removalDate: '2025-04-01'
44921+
deprecationDate: '2024-05-23'
4491644922
category: teams
4491744923
subcategory: teams
4491844924
deprecated: true
4491944925
put:
4492044926
summary: Add or update team project permissions (Legacy)
4492144927
description: |-
4492244928
> [!WARNING]
44923-
> **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.
44924-
44925-
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.
44929+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44930+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4492644931
tags:
4492744932
- teams
4492844933
operationId: teams/add-or-update-project-permissions-legacy
@@ -44982,18 +44987,17 @@ paths:
4498244987
x-github:
4498344988
githubCloudOnly: false
4498444989
enabledForGitHubApps: true
44985-
removalDate: '2021-02-01'
44986-
deprecationDate: '2020-01-21'
44990+
removalDate: '2025-04-01'
44991+
deprecationDate: '2024-05-23'
4498744992
category: teams
4498844993
subcategory: teams
4498944994
deprecated: true
4499044995
delete:
4499144996
summary: Remove a project from a team (Legacy)
4499244997
description: |-
4499344998
> [!WARNING]
44994-
> **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.
44995-
44996-
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.
44999+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
45000+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4499745001
tags:
4499845002
- teams
4499945003
operationId: teams/remove-project-legacy
@@ -45013,8 +45017,8 @@ paths:
4501345017
x-github:
4501445018
githubCloudOnly: false
4501545019
enabledForGitHubApps: true
45016-
removalDate: '2021-02-01'
45017-
deprecationDate: '2020-01-21'
45020+
removalDate: '2025-04-01'
45021+
deprecationDate: '2024-05-23'
4501845022
category: teams
4501945023
subcategory: teams
4502045024
deprecated: true

0 commit comments

Comments
 (0)