Search labels

GET

/search/labels

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

q=bug+defect+enhancement&repository_id=64778136

The labels that best match the query appear first in the search results.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/search/labels?repository_id=&q='

响应示例

200 - 示例 1

{
    "incomplete_results": true,
    "items": [
        {
            "color": "string",
            "default": true,
            "description": "string",
            "id": 0,
            "name": "string",
            "node_id": "string",
            "score": 0,
            "text_matches": [
                {
                    "fragment": "string",
                    "matches": [
                        {
                            "indices": [
                                0
                            ],
                            "text": "string"
                        }
                    ],
                    "object_type": "string",
                    "object_url": "string",
                    "property": "string"
                }
            ],
            "url": "http://example.com"
        }
    ],
    "total_count": 0
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

repository_id

integer

必需

The id of the repository.

string

必需

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

sort

string

可选

Sorts the results of your query by when the label was created or updated. Default: best match

order

string

可选

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

返回响应

🟢200Response

application/json

Body

incomplete_results

boolean

必需

items

array[object (Label Search Result Item) {9}]

必需

color

string

必需

default

boolean

必需

description

string | null

必需

integer

必需

name

string

必需

node_id

string

必需

score

number

必需

text_matches

array [object {5}]

可选

url

string <uri>

必需

total_count

integer

必需

🔵304304

🟠403403

🟠404404

🟠422422

修改于 2022-08-24 13:05:06

Search issues and pull requests

Search repositories