Skip to content

Commit 8bc127a

Browse files
Update OpenAPI 3.0 Descriptions
1 parent dee4dc2 commit 8bc127a

32 files changed

+3670934
-172
lines changed

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

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64011,7 +64011,7 @@
6401164011
"/search/issues": {
6401264012
"get": {
6401364013
"summary": "Search issues and pull requests",
64014-
"description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on November 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).",
64014+
"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).\"",
6401564015
"tags": [
6401664016
"search"
6401764017
],
@@ -64117,11 +64117,8 @@
6411764117
"githubCloudOnly": false,
6411864118
"enabledForGitHubApps": true,
6411964119
"category": "search",
64120-
"subcategory": "search",
64121-
"deprecationDate": "2025-03-04",
64122-
"removalDate": "2025-11-04"
64123-
},
64124-
"deprecated": true
64120+
"subcategory": "search"
64121+
}
6412564122
}
6412664123
},
6412764124
"/search/labels": {
@@ -292442,7 +292439,7 @@
292442292439
"created_at": "2022-09-12T12:14:32Z",
292443292440
"updated_at": "2022-09-12T12:14:32Z",
292444292441
"completed_at": "2022-09-12T13:15:33Z",
292445-
"status": "completed",
292442+
"status": "succeeded",
292446292443
"actions_workflow_run_id": 3453588,
292447292444
"scanned_repositories": [
292448292445
{

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

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46377,9 +46377,19 @@ paths:
4637746377
get:
4637846378
summary: Search issues and pull requests
4637946379
description: |-
46380-
> [!WARNING]
46381-
> **Notice:** Search for issues and pull requests will be overridden by advanced search on November 4, 2025.
46382-
> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).
46380+
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).
46381+
46382+
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
46383+
search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
46384+
46385+
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
46386+
46387+
`q=windows+label:bug+language:python+state:open&sort=created&order=asc`
46388+
46389+
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.
46390+
46391+
> [!NOTE]
46392+
> 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)."
4638346393
tags:
4638446394
- search
4638546395
operationId: search/issues-and-pull-requests
@@ -46460,9 +46470,6 @@ paths:
4646046470
enabledForGitHubApps: true
4646146471
category: search
4646246472
subcategory: search
46463-
deprecationDate: '2025-03-04'
46464-
removalDate: '2025-11-04'
46465-
deprecated: true
4646646473
"/search/labels":
4646746474
get:
4646846475
summary: Search labels
@@ -220300,7 +220307,7 @@ components:
220300220307
created_at: '2022-09-12T12:14:32Z'
220301220308
updated_at: '2022-09-12T12:14:32Z'
220302220309
completed_at: '2022-09-12T13:15:33Z'
220303-
status: completed
220310+
status: succeeded
220304220311
actions_workflow_run_id: 3453588
220305220312
scanned_repositories:
220306220313
- repository:

descriptions/api.github.com/api.github.com.json

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64011,7 +64011,7 @@
6401164011
"/search/issues": {
6401264012
"get": {
6401364013
"summary": "Search issues and pull requests",
64014-
"description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on November 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).",
64014+
"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).\"",
6401564015
"tags": [
6401664016
"search"
6401764017
],
@@ -64117,11 +64117,8 @@
6411764117
"githubCloudOnly": false,
6411864118
"enabledForGitHubApps": true,
6411964119
"category": "search",
64120-
"subcategory": "search",
64121-
"deprecationDate": "2025-03-04",
64122-
"removalDate": "2025-11-04"
64123-
},
64124-
"deprecated": true
64120+
"subcategory": "search"
64121+
}
6412564122
}
6412664123
},
6412764124
"/search/labels": {
@@ -292442,7 +292439,7 @@
292442292439
"created_at": "2022-09-12T12:14:32Z",
292443292440
"updated_at": "2022-09-12T12:14:32Z",
292444292441
"completed_at": "2022-09-12T13:15:33Z",
292445-
"status": "completed",
292442+
"status": "succeeded",
292446292443
"actions_workflow_run_id": 3453588,
292447292444
"scanned_repositories": [
292448292445
{

descriptions/api.github.com/api.github.com.yaml

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46377,9 +46377,19 @@ paths:
4637746377
get:
4637846378
summary: Search issues and pull requests
4637946379
description: |-
46380-
> [!WARNING]
46381-
> **Notice:** Search for issues and pull requests will be overridden by advanced search on November 4, 2025.
46382-
> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).
46380+
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).
46381+
46382+
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
46383+
search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
46384+
46385+
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
46386+
46387+
`q=windows+label:bug+language:python+state:open&sort=created&order=asc`
46388+
46389+
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.
46390+
46391+
> [!NOTE]
46392+
> 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)."
4638346393
tags:
4638446394
- search
4638546395
operationId: search/issues-and-pull-requests
@@ -46460,9 +46470,6 @@ paths:
4646046470
enabledForGitHubApps: true
4646146471
category: search
4646246472
subcategory: search
46463-
deprecationDate: '2025-03-04'
46464-
removalDate: '2025-11-04'
46465-
deprecated: true
4646646473
"/search/labels":
4646746474
get:
4646846475
summary: Search labels
@@ -220300,7 +220307,7 @@ components:
220300220307
created_at: '2022-09-12T12:14:32Z'
220301220308
updated_at: '2022-09-12T12:14:32Z'
220302220309
completed_at: '2022-09-12T13:15:33Z'
220303-
status: completed
220310+
status: succeeded
220304220311
actions_workflow_run_id: 3453588
220305220312
scanned_repositories:
220306220313
- repository:

0 commit comments

Comments
 (0)