Queries
search
Perform a search across resources, returning a maximum of 1,000 results.
类型: SearchResultItemConnection!
search 的参数
| 名称 | 说明 |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| The search string to look for. GitHub search syntax is supported. For more information, see "Searching on GitHub," "Understanding the search syntax," and "Sorting search results.". |
| The types of search items to search within. |
Objects
SearchResultItemConnection
A list of results that matched against a search query. Regardless of the number of matches, a maximum of 1,000 results will be available across all types, potentially split across many pages.
SearchResultItemConnection 字段
| 名称 | 说明 |
|---|---|
| The total number of pieces of code that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of discussions that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| A list of edges. |
| The total number of issues that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| A list of nodes. |
| Information to aid in pagination. |
| The total number of repositories that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of users that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
| The total number of wiki pages that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types. |
SearchResultItemEdge
An edge in a connection.
SearchResultItemEdge 字段
| 名称 | 说明 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
| Text matches on the result found. |
TextMatch
A text match within a search result.
TextMatch 字段
| 名称 | 说明 |
|---|---|
| The specific text fragment within the property matched on. |
| Highlights within the matched fragment. |
| The property matched on. |
TextMatchHighlight
Represents a single highlight in a search result match.
TextMatchHighlight 字段
| 名称 | 说明 |
|---|---|
| The indice in the fragment where the matched text begins. |
| The indice in the fragment where the matched text ends. |
| The text matched. |
Enums
SearchType
Represents the individual results of a search.
SearchType 的值
| 名称 | 说明 |
|---|---|
DISCUSSION | Returns matching discussions in repositories. |
ISSUE | Returns results matching issues in repositories. |
REPOSITORY | Returns results matching repositories. |
USER | Returns results matching users and organizations on GitHub. |
Unions
SearchResultItem
The results of a search.