Skip to content

Commit 5a58db1

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 6eb4013 commit 5a58db1

16 files changed

+608
-480
lines changed

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

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23819,7 +23819,7 @@
2381923819
"/orgs/{org}/teams/{team_slug}/projects": {
2382023820
"get": {
2382123821
"summary": "List team projects",
23822-
"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`.",
23822+
"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.",
2382323823
"tags": [
2382423824
"teams"
2382523825
],
@@ -23871,14 +23871,17 @@
2387123871
"githubCloudOnly": false,
2387223872
"enabledForGitHubApps": true,
2387323873
"category": "teams",
23874-
"subcategory": "teams"
23875-
}
23874+
"subcategory": "teams",
23875+
"deprecationDate": "2024-05-23",
23876+
"removalDate": "2025-04-01"
23877+
},
23878+
"deprecated": true
2387623879
}
2387723880
},
2387823881
"/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
2387923882
"get": {
2388023883
"summary": "Check team permissions for a project",
23881-
"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}`.",
23884+
"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.",
2388223885
"tags": [
2388323886
"teams"
2388423887
],
@@ -23922,12 +23925,15 @@
2392223925
"githubCloudOnly": false,
2392323926
"enabledForGitHubApps": true,
2392423927
"category": "teams",
23925-
"subcategory": "teams"
23926-
}
23928+
"subcategory": "teams",
23929+
"deprecationDate": "2024-05-23",
23930+
"removalDate": "2025-04-01"
23931+
},
23932+
"deprecated": true
2392723933
},
2392823934
"put": {
2392923935
"summary": "Add or update team project permissions",
23930-
"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}`.",
23936+
"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.",
2393123937
"tags": [
2393223938
"teams"
2393323939
],
@@ -24012,12 +24018,15 @@
2401224018
"githubCloudOnly": false,
2401324019
"enabledForGitHubApps": true,
2401424020
"category": "teams",
24015-
"subcategory": "teams"
24016-
}
24021+
"subcategory": "teams",
24022+
"deprecationDate": "2024-05-23",
24023+
"removalDate": "2025-04-01"
24024+
},
24025+
"deprecated": true
2401724026
},
2401824027
"delete": {
2401924028
"summary": "Remove a project from a team",
24020-
"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}`.",
24029+
"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.",
2402124030
"tags": [
2402224031
"teams"
2402324032
],
@@ -24046,8 +24055,11 @@
2404624055
"githubCloudOnly": false,
2404724056
"enabledForGitHubApps": true,
2404824057
"category": "teams",
24049-
"subcategory": "teams"
24050-
}
24058+
"subcategory": "teams",
24059+
"deprecationDate": "2024-05-23",
24060+
"removalDate": "2025-04-01"
24061+
},
24062+
"deprecated": true
2405124063
}
2405224064
},
2405324065
"/orgs/{org}/teams/{team_slug}/repos": {
@@ -61404,7 +61416,7 @@
6140461416
"/teams/{team_id}/projects": {
6140561417
"get": {
6140661418
"summary": "List team projects (Legacy)",
61407-
"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.",
61419+
"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.",
6140861420
"tags": [
6140961421
"teams"
6141061422
],
@@ -61455,8 +61467,8 @@
6145561467
"x-github": {
6145661468
"githubCloudOnly": false,
6145761469
"enabledForGitHubApps": true,
61458-
"removalDate": "2021-02-01",
61459-
"deprecationDate": "2020-01-21",
61470+
"removalDate": "2025-04-01",
61471+
"deprecationDate": "2024-05-23",
6146061472
"category": "teams",
6146161473
"subcategory": "teams"
6146261474
},
@@ -61466,7 +61478,7 @@
6146661478
"/teams/{team_id}/projects/{project_id}": {
6146761479
"get": {
6146861480
"summary": "Check team permissions for a project (Legacy)",
61469-
"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.",
61481+
"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.",
6147061482
"tags": [
6147161483
"teams"
6147261484
],
@@ -61506,16 +61518,16 @@
6150661518
"x-github": {
6150761519
"githubCloudOnly": false,
6150861520
"enabledForGitHubApps": true,
61509-
"removalDate": "2021-02-01",
61510-
"deprecationDate": "2020-01-21",
61521+
"removalDate": "2025-04-01",
61522+
"deprecationDate": "2024-05-23",
6151161523
"category": "teams",
6151261524
"subcategory": "teams"
6151361525
},
6151461526
"deprecated": true
6151561527
},
6151661528
"put": {
6151761529
"summary": "Add or update team project permissions (Legacy)",
61518-
"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.",
61530+
"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.",
6151961531
"tags": [
6152061532
"teams"
6152161533
],
@@ -61601,16 +61613,16 @@
6160161613
"x-github": {
6160261614
"githubCloudOnly": false,
6160361615
"enabledForGitHubApps": true,
61604-
"removalDate": "2021-02-01",
61605-
"deprecationDate": "2020-01-21",
61616+
"removalDate": "2025-04-01",
61617+
"deprecationDate": "2024-05-23",
6160661618
"category": "teams",
6160761619
"subcategory": "teams"
6160861620
},
6160961621
"deprecated": true
6161061622
},
6161161623
"delete": {
6161261624
"summary": "Remove a project from a team (Legacy)",
61613-
"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.",
61625+
"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.",
6161461626
"tags": [
6161561627
"teams"
6161661628
],
@@ -61641,8 +61653,8 @@
6164161653
"x-github": {
6164261654
"githubCloudOnly": false,
6164361655
"enabledForGitHubApps": true,
61644-
"removalDate": "2021-02-01",
61645-
"deprecationDate": "2020-01-21",
61656+
"removalDate": "2025-04-01",
61657+
"deprecationDate": "2024-05-23",
6164661658
"category": "teams",
6164761659
"subcategory": "teams"
6164861660
},

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

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17322,10 +17322,9 @@ paths:
1732217322
get:
1732317323
summary: List team projects
1732417324
description: |-
17325-
Lists the organization projects for a team.
17326-
17327-
> [!NOTE]
17328-
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.
17325+
> [!WARNING]
17326+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17327+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1732917328
tags:
1733017329
- teams
1733117330
operationId: teams/list-projects-in-org
@@ -17357,14 +17356,16 @@ paths:
1735717356
enabledForGitHubApps: true
1735817357
category: teams
1735917358
subcategory: teams
17359+
deprecationDate: '2024-05-23'
17360+
removalDate: '2025-04-01'
17361+
deprecated: true
1736017362
"/orgs/{org}/teams/{team_slug}/projects/{project_id}":
1736117363
get:
1736217364
summary: Check team permissions for a project
1736317365
description: |-
17364-
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
17365-
17366-
> [!NOTE]
17367-
> 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}`.
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.
1736817369
tags:
1736917370
- teams
1737017371
operationId: teams/check-permissions-for-project-in-org
@@ -17392,13 +17393,15 @@ paths:
1739217393
enabledForGitHubApps: true
1739317394
category: teams
1739417395
subcategory: teams
17396+
deprecationDate: '2024-05-23'
17397+
removalDate: '2025-04-01'
17398+
deprecated: true
1739517399
put:
1739617400
summary: Add or update team project permissions
1739717401
description: |-
17398-
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.
17399-
17400-
> [!NOTE]
17401-
> 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}`.
17402+
> [!WARNING]
17403+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17404+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1740217405
tags:
1740317406
- teams
1740417407
operationId: teams/add-or-update-project-permissions-in-org
@@ -17458,13 +17461,15 @@ paths:
1745817461
enabledForGitHubApps: true
1745917462
category: teams
1746017463
subcategory: teams
17464+
deprecationDate: '2024-05-23'
17465+
removalDate: '2025-04-01'
17466+
deprecated: true
1746117467
delete:
1746217468
summary: Remove a project from a team
1746317469
description: |-
17464-
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.
17465-
17466-
> [!NOTE]
17467-
> 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}`.
17470+
> [!WARNING]
17471+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
17472+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
1746817473
tags:
1746917474
- teams
1747017475
operationId: teams/remove-project-in-org
@@ -17483,6 +17488,9 @@ paths:
1748317488
enabledForGitHubApps: true
1748417489
category: teams
1748517490
subcategory: teams
17491+
deprecationDate: '2024-05-23'
17492+
removalDate: '2025-04-01'
17493+
deprecated: true
1748617494
"/orgs/{org}/teams/{team_slug}/repos":
1748717495
get:
1748817496
summary: List team repositories
@@ -44706,9 +44714,8 @@ paths:
4470644714
summary: List team projects (Legacy)
4470744715
description: |-
4470844716
> [!WARNING]
44709-
> **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.
44710-
44711-
Lists the organization projects for a team.
44717+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44718+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4471244719
tags:
4471344720
- teams
4471444721
operationId: teams/list-projects-legacy
@@ -44739,8 +44746,8 @@ paths:
4473944746
x-github:
4474044747
githubCloudOnly: false
4474144748
enabledForGitHubApps: true
44742-
removalDate: '2021-02-01'
44743-
deprecationDate: '2020-01-21'
44749+
removalDate: '2025-04-01'
44750+
deprecationDate: '2024-05-23'
4474444751
category: teams
4474544752
subcategory: teams
4474644753
deprecated: true
@@ -44749,9 +44756,8 @@ paths:
4474944756
summary: Check team permissions for a project (Legacy)
4475044757
description: |-
4475144758
> [!WARNING]
44752-
> **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.
44753-
44754-
Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
44759+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44760+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4475544761
tags:
4475644762
- teams
4475744763
operationId: teams/check-permissions-for-project-legacy
@@ -44776,18 +44782,17 @@ paths:
4477644782
x-github:
4477744783
githubCloudOnly: false
4477844784
enabledForGitHubApps: true
44779-
removalDate: '2021-02-01'
44780-
deprecationDate: '2020-01-21'
44785+
removalDate: '2025-04-01'
44786+
deprecationDate: '2024-05-23'
4478144787
category: teams
4478244788
subcategory: teams
4478344789
deprecated: true
4478444790
put:
4478544791
summary: Add or update team project permissions (Legacy)
4478644792
description: |-
4478744793
> [!WARNING]
44788-
> **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.
44789-
44790-
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.
44794+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44795+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4479144796
tags:
4479244797
- teams
4479344798
operationId: teams/add-or-update-project-permissions-legacy
@@ -44847,18 +44852,17 @@ paths:
4484744852
x-github:
4484844853
githubCloudOnly: false
4484944854
enabledForGitHubApps: true
44850-
removalDate: '2021-02-01'
44851-
deprecationDate: '2020-01-21'
44855+
removalDate: '2025-04-01'
44856+
deprecationDate: '2024-05-23'
4485244857
category: teams
4485344858
subcategory: teams
4485444859
deprecated: true
4485544860
delete:
4485644861
summary: Remove a project from a team (Legacy)
4485744862
description: |-
4485844863
> [!WARNING]
44859-
> **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.
44860-
44861-
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.
44864+
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
44865+
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
4486244866
tags:
4486344867
- teams
4486444868
operationId: teams/remove-project-legacy
@@ -44878,8 +44882,8 @@ paths:
4487844882
x-github:
4487944883
githubCloudOnly: false
4488044884
enabledForGitHubApps: true
44881-
removalDate: '2021-02-01'
44882-
deprecationDate: '2020-01-21'
44885+
removalDate: '2025-04-01'
44886+
deprecationDate: '2024-05-23'
4488344887
category: teams
4488444888
subcategory: teams
4488544889
deprecated: true

0 commit comments

Comments
 (0)