diff options
Diffstat (limited to 'descriptions/api.github.com/api.github.com.json')
| -rw-r--r-- | descriptions/api.github.com/api.github.com.json | 85 |
1 files changed, 56 insertions, 29 deletions
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index ef0db536f..94522eb26 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -23819,7 +23819,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" ], @@ -23871,14 +23871,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" ], @@ -23922,12 +23925,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" ], @@ -24012,12 +24018,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" ], @@ -24046,8 +24055,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": { @@ -59335,7 +59347,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" ], @@ -59384,6 +59396,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" } ], "responses": { @@ -59438,8 +59453,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "search", - "subcategory": "search" - } + "subcategory": "search", + "deprecationDate": "2025-03-04", + "removalDate": "2025-09-04" + }, + "deprecated": true } }, "/search/labels": { @@ -61404,7 +61422,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" ], @@ -61455,8 +61473,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" }, @@ -61466,7 +61484,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" ], @@ -61506,8 +61524,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" }, @@ -61515,7 +61533,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" ], @@ -61601,8 +61619,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" }, @@ -61610,7 +61628,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" ], @@ -61641,8 +61659,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" }, @@ -70192,7 +70210,7 @@ "200": { "description": "Response", "content": { - "application/json": { + "text/plain": { "schema": { "type": "string" }, @@ -299175,6 +299193,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.", @@ -299620,7 +299647,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": { |