diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 5b02c23bb..528bec3e4 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -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" ], @@ -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" ], @@ -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" ], @@ -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" ], @@ -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": { @@ -59602,7 +59614,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -59651,6 +59663,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -59705,8 +59720,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -61673,7 +61691,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" ], @@ -61724,8 +61742,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" }, @@ -61735,7 +61753,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" ], @@ -61775,8 +61793,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" }, @@ -61784,7 +61802,7 @@ }, "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" ], @@ -61870,8 +61888,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" }, @@ -61879,7 +61897,7 @@ }, "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" ], @@ -61910,8 +61928,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" }, @@ -70545,7 +70563,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -308192,6 +308210,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", @@ -308639,7 +308666,7 @@ } }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 8e8260686..320ab1738 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -43212,19 +43220,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -43268,6 +43265,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -43304,6 +43302,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -44841,9 +44842,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 @@ -44874,8 +44874,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 @@ -44884,9 +44884,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 @@ -44911,8 +44910,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 @@ -44920,9 +44919,8 @@ paths: 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 @@ -44982,8 +44980,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 @@ -44991,9 +44989,8 @@ paths: 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 @@ -45013,8 +45010,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 @@ -51141,7 +51138,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -230962,6 +230959,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -231260,7 +231266,8 @@ components: schema: "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 5b02c23bb..528bec3e4 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -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" ], @@ -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" ], @@ -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" ], @@ -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" ], @@ -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": { @@ -59602,7 +59614,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -59651,6 +59663,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -59705,8 +59720,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -61673,7 +61691,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" ], @@ -61724,8 +61742,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" }, @@ -61735,7 +61753,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" ], @@ -61775,8 +61793,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" }, @@ -61784,7 +61802,7 @@ }, "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" ], @@ -61870,8 +61888,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" }, @@ -61879,7 +61897,7 @@ }, "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" ], @@ -61910,8 +61928,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" }, @@ -70545,7 +70563,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -308192,6 +308210,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", @@ -308639,7 +308666,7 @@ } }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 8e8260686..320ab1738 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -43212,19 +43220,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -43268,6 +43265,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -43304,6 +43302,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -44841,9 +44842,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 @@ -44874,8 +44874,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 @@ -44884,9 +44884,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 @@ -44911,8 +44910,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 @@ -44920,9 +44919,8 @@ paths: 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 @@ -44982,8 +44980,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 @@ -44991,9 +44989,8 @@ paths: 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 @@ -45013,8 +45010,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 @@ -51141,7 +51138,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -230962,6 +230959,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -231260,7 +231266,8 @@ components: schema: "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 87db4b8b2..bc2757cd5 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -167740,7 +167740,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" ], @@ -168115,14 +168115,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" ], @@ -168478,12 +168481,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" ], @@ -168588,12 +168594,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" ], @@ -168640,8 +168649,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": { @@ -300614,7 +300626,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -524104,7 +524116,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -524176,6 +524188,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -526980,8 +527001,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -538112,7 +538136,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" ], @@ -538503,8 +538527,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" }, @@ -538514,7 +538538,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" ], @@ -538860,8 +538884,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" }, @@ -538869,7 +538893,7 @@ }, "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" ], @@ -539062,8 +539086,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" }, @@ -539071,7 +539095,7 @@ }, "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" ], @@ -539209,8 +539233,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" }, @@ -639169,7 +639193,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f0fffd06a..2b0805ddd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -40082,10 +40082,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 @@ -40219,14 +40218,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 @@ -40296,13 +40297,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 @@ -40363,13 +40366,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 @@ -40388,6 +40393,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 @@ -64685,8 +64693,8 @@ paths: Link: *57 '404': *6 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *3 @@ -89232,19 +89240,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -89288,6 +89285,14 @@ paths: - *564 - *17 - *19 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -89593,6 +89598,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -91867,9 +91875,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 @@ -91896,8 +91903,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 @@ -91906,9 +91913,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 @@ -91931,8 +91937,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 @@ -91940,9 +91946,8 @@ paths: 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 @@ -92000,8 +92005,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 @@ -92009,9 +92014,8 @@ paths: 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 @@ -92029,8 +92033,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 @@ -101161,7 +101165,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 87db4b8b2..bc2757cd5 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -167740,7 +167740,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" ], @@ -168115,14 +168115,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" ], @@ -168478,12 +168481,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" ], @@ -168588,12 +168594,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" ], @@ -168640,8 +168649,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": { @@ -300614,7 +300626,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -524104,7 +524116,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -524176,6 +524188,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -526980,8 +527001,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -538112,7 +538136,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" ], @@ -538503,8 +538527,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" }, @@ -538514,7 +538538,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" ], @@ -538860,8 +538884,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" }, @@ -538869,7 +538893,7 @@ }, "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" ], @@ -539062,8 +539086,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" }, @@ -539071,7 +539095,7 @@ }, "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" ], @@ -539209,8 +539233,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" }, @@ -639169,7 +639193,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index f0fffd06a..2b0805ddd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -40082,10 +40082,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 @@ -40219,14 +40218,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 @@ -40296,13 +40297,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 @@ -40363,13 +40366,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 @@ -40388,6 +40393,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 @@ -64685,8 +64693,8 @@ paths: Link: *57 '404': *6 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *3 @@ -89232,19 +89240,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -89288,6 +89285,14 @@ paths: - *564 - *17 - *19 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -89593,6 +89598,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -91867,9 +91875,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 @@ -91896,8 +91903,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 @@ -91906,9 +91913,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 @@ -91931,8 +91937,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 @@ -91940,9 +91946,8 @@ paths: 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 @@ -92000,8 +92005,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 @@ -92009,9 +92014,8 @@ paths: 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 @@ -92029,8 +92033,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 @@ -101161,7 +101165,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 727a0f5af..ae476e91b 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -203122,7 +203122,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" ], @@ -203497,14 +203497,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" ], @@ -203860,12 +203863,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" ], @@ -203970,12 +203976,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" ], @@ -204022,8 +204031,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": { @@ -338739,7 +338751,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -573922,7 +573934,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -573994,6 +574006,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -576798,8 +576819,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -587930,7 +587954,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/enterprise-cloud@latest//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" ], @@ -588321,8 +588345,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" }, @@ -588332,7 +588356,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/enterprise-cloud@latest//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" ], @@ -588678,8 +588702,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" }, @@ -588687,7 +588711,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -588880,8 +588904,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" }, @@ -588889,7 +588913,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -589027,8 +589051,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" }, @@ -689740,7 +689764,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 712bad64c..6938802ab 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -47967,10 +47967,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 @@ -48104,14 +48103,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 @@ -48181,13 +48182,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 @@ -48248,13 +48251,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 @@ -48273,6 +48278,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 @@ -73031,8 +73039,8 @@ paths: Link: *37 '404': *6 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *3 @@ -99699,19 +99707,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -99756,6 +99753,14 @@ paths: - *674 - *17 - *19 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -100061,6 +100066,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -102339,9 +102347,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/enterprise-cloud@latest//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 @@ -102368,8 +102375,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 @@ -102378,9 +102385,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/enterprise-cloud@latest//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 @@ -102403,8 +102409,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 @@ -102412,9 +102418,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -102472,8 +102477,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 @@ -102481,9 +102486,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -102501,8 +102505,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 @@ -111764,7 +111768,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 727a0f5af..ae476e91b 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -203122,7 +203122,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" ], @@ -203497,14 +203497,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" ], @@ -203860,12 +203863,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" ], @@ -203970,12 +203976,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" ], @@ -204022,8 +204031,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": { @@ -338739,7 +338751,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -573922,7 +573934,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -573994,6 +574006,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -576798,8 +576819,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -587930,7 +587954,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/enterprise-cloud@latest//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" ], @@ -588321,8 +588345,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" }, @@ -588332,7 +588356,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/enterprise-cloud@latest//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" ], @@ -588678,8 +588702,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" }, @@ -588687,7 +588711,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -588880,8 +588904,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" }, @@ -588889,7 +588913,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -589027,8 +589051,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" }, @@ -689740,7 +689764,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 712bad64c..6938802ab 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -47967,10 +47967,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 @@ -48104,14 +48103,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 @@ -48181,13 +48182,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 @@ -48248,13 +48251,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 @@ -48273,6 +48278,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 @@ -73031,8 +73039,8 @@ paths: Link: *37 '404': *6 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *3 @@ -99699,19 +99707,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -99756,6 +99753,14 @@ paths: - *674 - *17 - *19 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -100061,6 +100066,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -102339,9 +102347,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/enterprise-cloud@latest//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 @@ -102368,8 +102375,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 @@ -102378,9 +102385,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/enterprise-cloud@latest//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 @@ -102403,8 +102409,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 @@ -102412,9 +102418,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -102472,8 +102477,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 @@ -102481,9 +102486,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -102501,8 +102505,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 @@ -111764,7 +111768,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index ab99241ad..b9ac30764 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -31514,7 +31514,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" ], @@ -31566,14 +31566,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" ], @@ -31617,12 +31620,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" ], @@ -31709,12 +31715,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" ], @@ -31743,8 +31752,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": { @@ -69572,7 +69584,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -69621,6 +69633,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -69675,8 +69690,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -71643,7 +71661,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/enterprise-cloud@latest//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" ], @@ -71694,8 +71712,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" }, @@ -71705,7 +71723,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/enterprise-cloud@latest//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" ], @@ -71745,8 +71763,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" }, @@ -71754,7 +71772,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -71840,8 +71858,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" }, @@ -71849,7 +71867,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -71880,8 +71898,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" }, @@ -80694,7 +80712,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -324946,6 +324964,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", @@ -325467,7 +325494,7 @@ } }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 03476a3b7..107dd25ab 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -22855,10 +22855,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 @@ -22890,14 +22889,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 @@ -22925,13 +22926,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 @@ -22992,13 +22995,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 @@ -23017,6 +23022,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 @@ -50368,19 +50376,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -50425,6 +50422,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -50461,6 +50459,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -52002,9 +52003,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/enterprise-cloud@latest//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 @@ -52035,8 +52035,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 @@ -52045,9 +52045,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/enterprise-cloud@latest//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 @@ -52072,8 +52071,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 @@ -52081,9 +52080,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -52143,8 +52141,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 @@ -52152,9 +52150,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -52174,8 +52171,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 @@ -58436,7 +58433,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -243109,6 +243106,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -243451,7 +243457,8 @@ components: schema: "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index ab99241ad..b9ac30764 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -31514,7 +31514,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" ], @@ -31566,14 +31566,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" ], @@ -31617,12 +31620,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" ], @@ -31709,12 +31715,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" ], @@ -31743,8 +31752,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": { @@ -69572,7 +69584,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -69621,6 +69633,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -69675,8 +69690,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -71643,7 +71661,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/enterprise-cloud@latest//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" ], @@ -71694,8 +71712,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" }, @@ -71705,7 +71723,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/enterprise-cloud@latest//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" ], @@ -71745,8 +71763,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" }, @@ -71754,7 +71772,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -71840,8 +71858,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" }, @@ -71849,7 +71867,7 @@ }, "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/enterprise-cloud@latest//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" ], @@ -71880,8 +71898,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" }, @@ -80694,7 +80712,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -324946,6 +324964,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", @@ -325467,7 +325494,7 @@ } }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 03476a3b7..107dd25ab 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -22855,10 +22855,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 @@ -22890,14 +22889,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 @@ -22925,13 +22926,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 @@ -22992,13 +22995,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 @@ -23017,6 +23022,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 @@ -50368,19 +50376,8 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!WARNING] + > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. tags: - search operationId: search/issues-and-pull-requests @@ -50425,6 +50422,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -50461,6 +50459,9 @@ paths: enabledForGitHubApps: true category: search subcategory: search + deprecationDate: '2025-03-04' + removalDate: '2025-09-04' + deprecated: true "/search/labels": get: summary: Search labels @@ -52002,9 +52003,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/enterprise-cloud@latest//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 @@ -52035,8 +52035,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 @@ -52045,9 +52045,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/enterprise-cloud@latest//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 @@ -52072,8 +52071,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 @@ -52081,9 +52080,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -52143,8 +52141,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 @@ -52152,9 +52150,8 @@ paths: 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/enterprise-cloud@latest//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 @@ -52174,8 +52171,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 @@ -58436,7 +58433,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -243109,6 +243106,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -243451,7 +243457,8 @@ components: schema: "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index 3d09fe14c..28bbc5a25 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -271100,7 +271100,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -459886,6 +459886,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -549254,7 +549263,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index 4c84bf823..d3b4daf72 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -58071,8 +58071,8 @@ paths: Link: *6 '404': *24 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *22 @@ -80693,6 +80693,14 @@ paths: - *539 - *4 - *5 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -90943,7 +90951,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json index 3d09fe14c..28bbc5a25 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -271100,7 +271100,7 @@ } }, "403": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { @@ -459886,6 +459886,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -549254,7 +549263,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index 4c84bf823..d3b4daf72 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -58071,8 +58071,8 @@ paths: Link: *6 '404': *24 '403': - description: Response if GitHub Advanced Security is not enabled for this - repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: *22 @@ -80693,6 +80693,14 @@ paths: - *539 - *4 - *5 + - name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -90943,7 +90951,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json index 423732fc5..f70e7f2ee 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json @@ -55626,6 +55626,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -65004,7 +65007,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -288529,6 +288532,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "gpg-key-id": { "name": "gpg_key_id", "description": "The unique identifier of the GPG key.", @@ -288963,7 +288975,7 @@ "description": "Found" }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml index e3b56ec91..9b31c33b7 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -40075,6 +40075,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -46859,7 +46860,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -215014,6 +215015,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string gpg-key-id: name: gpg_key_id description: The unique identifier of the GPG key. @@ -215304,7 +215314,8 @@ components: found: description: Found dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: diff --git a/descriptions-next/ghes-3.12/ghes-3.12.json b/descriptions-next/ghes-3.12/ghes-3.12.json index 423732fc5..f70e7f2ee 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.json @@ -55626,6 +55626,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -65004,7 +65007,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -288529,6 +288532,15 @@ "default": "desc" } }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, "gpg-key-id": { "name": "gpg_key_id", "description": "The unique identifier of the GPG key.", @@ -288963,7 +288975,7 @@ "description": "Found" }, "dependency_review_forbidden": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghes-3.12/ghes-3.12.yaml b/descriptions-next/ghes-3.12/ghes-3.12.yaml index e3b56ec91..9b31c33b7 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.yaml @@ -40075,6 +40075,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -46859,7 +46860,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -215014,6 +215015,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}