366.md 29.1 KB
Newer Older
Lab机器人's avatar
readme  
Lab机器人 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
# Search API

> 原文:[https://docs.gitlab.com/ee/api/search.html](https://docs.gitlab.com/ee/api/search.html)

*   [Global Search API](#global-search-api)
    *   [Scope: projects](#scope-projects)
    *   [Scope: issues](#scope-issues)
    *   [Scope: merge_requests](#scope-merge_requests)
    *   [Scope: milestones](#scope-milestones)
    *   [Scope: snippet_titles](#scope-snippet_titles)
    *   [Scope: wiki_blobs](#scope-wiki_blobs-starter)
    *   [Scope: commits](#scope-commits-starter)
    *   [Scope: blobs](#scope-blobs-starter)
    *   [Scope: users](#scope-users)
*   [Group Search API](#group-search-api)
    *   [Scope: projects](#scope-projects-1)
    *   [Scope: issues](#scope-issues-1)
    *   [Scope: merge_requests](#scope-merge_requests-1)
    *   [Scope: milestones](#scope-milestones-1)
    *   [Scope: wiki_blobs](#scope-wiki_blobs-starter-1)
    *   [Scope: commits](#scope-commits-starter-1)
    *   [Scope: blobs](#scope-blobs-starter-1)
    *   [Scope: users](#scope-users-1)
*   [Project Search API](#project-search-api)
    *   [Scope: issues](#scope-issues-2)
    *   [Scope: merge_requests](#scope-merge_requests-2)
    *   [Scope: milestones](#scope-milestones-2)
    *   [Scope: notes](#scope-notes)
    *   [Scope: wiki_blobs](#scope-wiki_blobs)
    *   [Scope: commits](#scope-commits)
    *   [Scope: blobs](#scope-blobs)
    *   [Scope: users](#scope-users-2)

# Search API[](#search-api "Permalink")

在 GitLab 10.5 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41763) .

搜索的每个 API 调用都必须经过验证.

## Global Search API[](#global-search-api "Permalink")

在整个 GitLab 实例中进行全局搜索.

```
GET /search 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `scope` | string | yes | 搜索范围 |
| `search` | string | yes | 搜索查询 |

在指定范围内搜索表达式. 当前支持以下范围:项目,问题,merge_requests,里程碑,snippet_titles,用户.

如果启用了 Elasticsearch,则其他可用范围是 blob,wiki_blobs 和 commits. 查找有关[该功能的](../integration/elasticsearch.html)更多信息.

响应取决于请求的范围.

### Scope: projects[](#scope-projects "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=projects&search=flight" 
```

响应示例:

```
[  {  "id":  6,  "description":  "Nobis sed ipsam vero quod cupiditate veritatis hic.",  "name":  "Flight",  "name_with_namespace":  "Twitter / Flight",  "path":  "flight",  "path_with_namespace":  "twitter/flight",  "created_at":  "2017-09-05T07:58:01.621Z",  "default_branch":  "master",  "tag_list":[],  "ssh_url_to_repo":  "ssh://jarka@localhost:2222/twitter/flight.git",  "http_url_to_repo":  "http://localhost:3000/twitter/flight.git",  "web_url":  "http://localhost:3000/twitter/flight",  "avatar_url":  null,  "star_count":  0,  "forks_count":  0,  "last_activity_at":  "2018-01-31T09:56:30.902Z"  }  ] 
```

### Scope: issues[](#scope-issues "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=issues&search=file" 
```

响应示例:

```
[  {  "id":  83,  "iid":  1,  "project_id":  12,  "title":  "Add file",  "description":  "Add first file",  "state":  "opened",  "created_at":  "2018-01-24T06:02:15.514Z",  "updated_at":  "2018-02-06T12:36:23.263Z",  "closed_at":  null,  "labels":[],  "milestone":  null,  "assignees":  [{  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  }],  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  },  "user_notes_count":  0,  "upvotes":  0,  "downvotes":  0,  "due_date":  null,  "confidential":  false,  "discussion_locked":  null,  "web_url":  "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

**注意** :不建议使用`assignee`列,现在我们将其显示为符合 GitLab EE API 的单一大小的数组`assignees` .

### Scope: merge_requests[](#scope-merge_requests "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file" 
```

响应示例:

```
[  {  "id":  56,  "iid":  8,  "project_id":  6,  "title":  "Add first file",  "description":  "This is a test MR to add file",  "state":  "opened",  "created_at":  "2018-01-22T14:21:50.830Z",  "updated_at":  "2018-02-06T12:40:33.295Z",  "target_branch":  "master",  "source_branch":  "jaja-test",  "upvotes":  0,  "downvotes":  0,  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  5,  "name":  "Jacquelyn Kutch",  "username":  "abigail",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",  "web_url":  "http://localhost:3000/abigail"  },  "source_project_id":  6,  "target_project_id":  6,  "labels":  [  "ruby",  "tests"  ],  "work_in_progress":  false,  "milestone":  {  "id":  13,  "iid":  3,  "project_id":  6,  "title":  "v2.0",  "description":  "Qui aut qui eos dolor beatae itaque tempore molestiae.",  "state":  "active",  "created_at":  "2017-09-05T07:58:29.099Z",  "updated_at":  "2017-09-05T07:58:29.099Z",  "due_date":  null,  "start_date":  null  },  "merge_when_pipeline_succeeds":  false,  "merge_status":  "can_be_merged",  "sha":  "78765a2d5e0a43585945c58e61ba2f822e4d090b",  "merge_commit_sha":  null,  "squash_commit_sha":  null,  "user_notes_count":  0,  "discussion_locked":  null,  "should_remove_source_branch":  null,  "force_remove_source_branch":  true,  "web_url":  "http://localhost:3000/twitter/flight/merge_requests/8",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

### Scope: milestones[](#scope-milestones "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=milestones&search=release" 
```

响应示例:

```
[  {  "id":  44,  "iid":  1,  "project_id":  12,  "title":  "next release",  "description":  "Next release milestone",  "state":  "active",  "created_at":  "2018-02-06T12:43:39.271Z",  "updated_at":  "2018-02-06T12:44:01.298Z",  "due_date":  "2018-04-18",  "start_date":  "2018-02-04"  }  ] 
```

### Scope: snippet_titles[](#scope-snippet_titles "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample" 
```

响应示例:

```
[  {  "id":  50,  "title":  "Sample file",  "file_name":  "file.rb",  "description":  "Simple ruby file",  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "updated_at":  "2018-02-06T12:49:29.104Z",  "created_at":  "2017-11-28T08:20:18.071Z",  "project_id":  9,  "web_url":  "http://localhost:3000/root/jira-test/snippets/50"  }  ] 
```

### Scope: wiki_blobs[](#scope-wiki_blobs-starter "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye" 
```

Example response:

```
 [  {  "basename":  "home",  "data":  "hello\n\nand bye\n\nend",  "path":  "home.md",  "filename":  "home.md",  "id":  null,  "ref":  "master",  "startline":  5,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: commits[](#scope-commits-starter "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=commits&search=bye" 
```

响应示例:

```
 [  {  "id":  "4109c2d872d5fdb1ed057400d103766aaea97f98",  "short_id":  "4109c2d8",  "title":  "goodbye $.browser",  "created_at":  "2013-02-18T22:02:54.000Z",  "parent_ids":  [  "59d05353ab575bcc2aa958fe1782e93297de64c9"  ],  "message":  "goodbye $.browser\n",  "author_name":  "angus croll",  "author_email":  "anguscroll@gmail.com",  "authored_date":  "2013-02-18T22:02:54.000Z",  "committer_name":  "angus croll",  "committer_email":  "anguscroll@gmail.com",  "committed_date":  "2013-02-18T22:02:54.000Z",  "project_id":  6  }  ] 
```

### Scope: blobs[](#scope-blobs-starter "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

过滤器可用于以下范围:

*   filename
*   path
*   extension

要使用过滤器,只需将其包含在查询中,如下所示: `a query filename:some_name*` .

您可以使用通配符( `*` )使用全局匹配.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=blobs&search=installation" 
```

响应示例:

```
 [  {  "basename":  "README",  "data":  "```\n\n## Installation\n\nQuick start using the [pre-built",  "path":  "README.md",  "filename":  "README.md",  "id":  null,  "ref":  "master",  "startline":  46,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: users[](#scope-users "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=users&search=doe" 
```

响应示例:

```
[  {  "id":  1,  "name":  "John Doe1",  "username":  "user1",  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",  "web_url":  "http://localhost/user1"  }  ] 
```

## Group Search API[](#group-search-api "Permalink")

在指定的组中搜索.

如果用户不是组的成员,并且该组是私有的,则对该组的`GET`请求将导致`404`状态代码.

```
GET /groups/:id/search 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `scope` | string | yes | 搜索范围 |
| `search` | string | yes | 搜索查询 |

在指定范围内搜索表达式. 当前支持以下范围:项目,问题,merge_requests,里程碑,用户.

如果启用了 Elasticsearch,则其他可用范围是 blob,wiki_blobs 和 commits. 查找有关[该功能的](../integration/elasticsearch.html)更多信息.

响应取决于请求的范围.

### Scope: projects[](#scope-projects-1 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight" 
```

响应示例:

```
[  {  "id":  6,  "description":  "Nobis sed ipsam vero quod cupiditate veritatis hic.",  "name":  "Flight",  "name_with_namespace":  "Twitter / Flight",  "path":  "flight",  "path_with_namespace":  "twitter/flight",  "created_at":  "2017-09-05T07:58:01.621Z",  "default_branch":  "master",  "tag_list":[],  "ssh_url_to_repo":  "ssh://jarka@localhost:2222/twitter/flight.git",  "http_url_to_repo":  "http://localhost:3000/twitter/flight.git",  "web_url":  "http://localhost:3000/twitter/flight",  "avatar_url":  null,  "star_count":  0,  "forks_count":  0,  "last_activity_at":  "2018-01-31T09:56:30.902Z"  }  ] 
```

### Scope: issues[](#scope-issues-1 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file" 
```

响应示例:

```
[  {  "id":  83,  "iid":  1,  "project_id":  12,  "title":  "Add file",  "description":  "Add first file",  "state":  "opened",  "created_at":  "2018-01-24T06:02:15.514Z",  "updated_at":  "2018-02-06T12:36:23.263Z",  "closed_at":  null,  "labels":[],  "milestone":  null,  "assignees":  [{  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  }],  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  },  "user_notes_count":  0,  "upvotes":  0,  "downvotes":  0,  "due_date":  null,  "confidential":  false,  "discussion_locked":  null,  "web_url":  "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

**注意** :不建议使用`assignee`列,现在我们将其显示为符合 GitLab EE API 的单一大小的数组`assignees` .

### Scope: merge_requests[](#scope-merge_requests-1 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file" 
```

响应示例:

```
[  {  "id":  56,  "iid":  8,  "project_id":  6,  "title":  "Add first file",  "description":  "This is a test MR to add file",  "state":  "opened",  "created_at":  "2018-01-22T14:21:50.830Z",  "updated_at":  "2018-02-06T12:40:33.295Z",  "target_branch":  "master",  "source_branch":  "jaja-test",  "upvotes":  0,  "downvotes":  0,  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  5,  "name":  "Jacquelyn Kutch",  "username":  "abigail",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",  "web_url":  "http://localhost:3000/abigail"  },  "source_project_id":  6,  "target_project_id":  6,  "labels":  [  "ruby",  "tests"  ],  "work_in_progress":  false,  "milestone":  {  "id":  13,  "iid":  3,  "project_id":  6,  "title":  "v2.0",  "description":  "Qui aut qui eos dolor beatae itaque tempore molestiae.",  "state":  "active",  "created_at":  "2017-09-05T07:58:29.099Z",  "updated_at":  "2017-09-05T07:58:29.099Z",  "due_date":  null,  "start_date":  null  },  "merge_when_pipeline_succeeds":  false,  "merge_status":  "can_be_merged",  "sha":  "78765a2d5e0a43585945c58e61ba2f822e4d090b",  "merge_commit_sha":  null,  "squash_commit_sha":  null,  "user_notes_count":  0,  "discussion_locked":  null,  "should_remove_source_branch":  null,  "force_remove_source_branch":  true,  "web_url":  "http://localhost:3000/twitter/flight/merge_requests/8",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

### Scope: milestones[](#scope-milestones-1 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release" 
```

响应示例:

```
[  {  "id":  44,  "iid":  1,  "project_id":  12,  "title":  "next release",  "description":  "Next release milestone",  "state":  "active",  "created_at":  "2018-02-06T12:43:39.271Z",  "updated_at":  "2018-02-06T12:44:01.298Z",  "due_date":  "2018-04-18",  "start_date":  "2018-02-04"  }  ] 
```

### Scope: wiki_blobs[](#scope-wiki_blobs-starter-1 "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye" 
```

响应示例:

```
 [  {  "basename":  "home",  "data":  "hello\n\nand bye\n\nend",  "path":  "home.md",  "filename":  "home.md",  "id":  null,  "ref":  "master",  "startline":  5,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: commits[](#scope-commits-starter-1 "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye" 
```

响应示例:

```
 [  {  "id":  "4109c2d872d5fdb1ed057400d103766aaea97f98",  "short_id":  "4109c2d8",  "title":  "goodbye $.browser",  "created_at":  "2013-02-18T22:02:54.000Z",  "parent_ids":  [  "59d05353ab575bcc2aa958fe1782e93297de64c9"  ],  "message":  "goodbye $.browser\n",  "author_name":  "angus croll",  "author_email":  "anguscroll@gmail.com",  "authored_date":  "2013-02-18T22:02:54.000Z",  "committer_name":  "angus croll",  "committer_email":  "anguscroll@gmail.com",  "committed_date":  "2013-02-18T22:02:54.000Z",  "project_id":  6  }  ] 
```

### Scope: blobs[](#scope-blobs-starter-1 "Permalink")

仅当启用[Elasticsearch 时,](../integration/elasticsearch.html)此范围才可用.

过滤器可用于以下范围:

*   filename
*   path
*   extension

要使用过滤器,只需将其包含在查询中,如下所示: `a query filename:some_name*` .

您可以使用通配符( `*` )使用全局匹配.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation" 
```

响应示例:

```
 [  {  "basename":  "README",  "data":  "```\n\n## Installation\n\nQuick start using the [pre-built",  "path":  "README.md",  "filename":  "README.md",  "id":  null,  "ref":  "master",  "startline":  46,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: users[](#scope-users-1 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe" 
```

响应示例:

```
[  {  "id":  1,  "name":  "John Doe1",  "username":  "user1",  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",  "web_url":  "http://localhost/user1"  }  ] 
```

## Project Search API[](#project-search-api "Permalink")

在指定项目中搜索.

如果用户不是项目成员,并且该项目是私有项目,则对该项目的`GET`请求将导致`404`状态代码.

```
GET /projects/:id/search 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 经过身份验证的用户拥有[的项目](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `scope` | string | yes | 搜索范围 |
| `search` | string | yes | 搜索查询 |
| `ref` | string | no | 要搜索的存储库分支或标记的名称. 默认情况下使用项目的默认分支. 这仅适用于范围:commit,blob 和 wiki_blobs. |

在指定范围内搜索表达式. 当前支持以下范围:问题,merge_requests,里程碑,注释,wiki_blob,提交,blob,用户.

响应取决于请求的范围.

### Scope: issues[](#scope-issues-2 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file" 
```

响应示例:

```
[  {  "id":  83,  "iid":  1,  "project_id":  12,  "title":  "Add file",  "description":  "Add first file",  "state":  "opened",  "created_at":  "2018-01-24T06:02:15.514Z",  "updated_at":  "2018-02-06T12:36:23.263Z",  "closed_at":  null,  "labels":[],  "milestone":  null,  "assignees":  [{  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  }],  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  20,  "name":  "Ceola Deckow",  "username":  "sammy.collier",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",  "web_url":  "http://localhost:3000/sammy.collier"  },  "user_notes_count":  0,  "upvotes":  0,  "downvotes":  0,  "due_date":  null,  "confidential":  false,  "discussion_locked":  null,  "web_url":  "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

**注意** :不建议使用`assignee`列,现在我们将其显示为符合 GitLab EE API 的单一大小的数组`assignees` .

### Scope: merge_requests[](#scope-merge_requests-2 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file" 
```

响应示例:

```
[  {  "id":  56,  "iid":  8,  "project_id":  6,  "title":  "Add first file",  "description":  "This is a test MR to add file",  "state":  "opened",  "created_at":  "2018-01-22T14:21:50.830Z",  "updated_at":  "2018-02-06T12:40:33.295Z",  "target_branch":  "master",  "source_branch":  "jaja-test",  "upvotes":  0,  "downvotes":  0,  "author":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "assignee":  {  "id":  5,  "name":  "Jacquelyn Kutch",  "username":  "abigail",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",  "web_url":  "http://localhost:3000/abigail"  },  "source_project_id":  6,  "target_project_id":  6,  "labels":  [  "ruby",  "tests"  ],  "work_in_progress":  false,  "milestone":  {  "id":  13,  "iid":  3,  "project_id":  6,  "title":  "v2.0",  "description":  "Qui aut qui eos dolor beatae itaque tempore molestiae.",  "state":  "active",  "created_at":  "2017-09-05T07:58:29.099Z",  "updated_at":  "2017-09-05T07:58:29.099Z",  "due_date":  null,  "start_date":  null  },  "merge_when_pipeline_succeeds":  false,  "merge_status":  "can_be_merged",  "sha":  "78765a2d5e0a43585945c58e61ba2f822e4d090b",  "merge_commit_sha":  null,  "squash_commit_sha":  null,  "user_notes_count":  0,  "discussion_locked":  null,  "should_remove_source_branch":  null,  "force_remove_source_branch":  true,  "web_url":  "http://localhost:3000/twitter/flight/merge_requests/8",  "time_stats":  {  "time_estimate":  0,  "total_time_spent":  0,  "human_time_estimate":  null,  "human_total_time_spent":  null  }  }  ] 
```

### Scope: milestones[](#scope-milestones-2 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release" 
```

响应示例:

```
[  {  "id":  44,  "iid":  1,  "project_id":  12,  "title":  "next release",  "description":  "Next release milestone",  "state":  "active",  "created_at":  "2018-02-06T12:43:39.271Z",  "updated_at":  "2018-02-06T12:44:01.298Z",  "due_date":  "2018-04-18",  "start_date":  "2018-02-04"  }  ] 
```

### Scope: notes[](#scope-notes "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime" 
```

响应示例:

```
[  {  "id":  191,  "body":  "Harum maxime consequuntur et et deleniti assumenda facilis.",  "attachment":  null,  "author":  {  "id":  23,  "name":  "User 1",  "username":  "user1",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/111d68d06e2d317b5a59c2c6c5bad808?s=80&d=identicon",  "web_url":  "http://localhost:3000/user1"  },  "created_at":  "2017-09-05T08:01:32.068Z",  "updated_at":  "2017-09-05T08:01:32.068Z",  "system":  false,  "noteable_id":  22,  "noteable_type":  "Issue",  "noteable_iid":  2  }  ] 
```

### Scope: wiki_blobs[](#scope-wiki_blobs "Permalink")

过滤器可用于以下范围:

*   filename
*   path
*   extension

要使用过滤器,只需将其包含在查询中,例如: `a query filename:some_name*` . 您可以使用通配符( `*` )使用全局匹配.

Wiki blobs searches are performed on both filenames and contents. Search results:

*   在文件名中找到的结果显示在内容中之前.
*   可能包含同一 blob 的多个匹配项,因为可能在文件名和内容中都找到了搜索字符串,或者在内容中可能出现了多次.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye" 
```

响应示例:

```
 [  {  "basename":  "home",  "data":  "hello\n\nand bye\n\nend",  "path":  "home.md",  "filename":  "home.md",  "id":  null,  "ref":  "master",  "startline":  5,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: commits[](#scope-commits "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye" 
```

响应示例:

```
 [  {  "id":  "4109c2d872d5fdb1ed057400d103766aaea97f98",  "short_id":  "4109c2d8",  "title":  "goodbye $.browser",  "created_at":  "2013-02-18T22:02:54.000Z",  "parent_ids":  [  "59d05353ab575bcc2aa958fe1782e93297de64c9"  ],  "message":  "goodbye $.browser\n",  "author_name":  "angus croll",  "author_email":  "anguscroll@gmail.com",  "authored_date":  "2013-02-18T22:02:54.000Z",  "committer_name":  "angus croll",  "committer_email":  "anguscroll@gmail.com",  "committed_date":  "2013-02-18T22:02:54.000Z",  "project_id":  6  }  ] 
```

### Scope: blobs[](#scope-blobs "Permalink")

过滤器可用于以下范围:

*   filename
*   path
*   extension

要使用过滤器,只需将其包含在查询中,例如: `a query filename:some_name*` . 您可以使用通配符( `*` )使用全局匹配.

对文件名和内容都进行 Blob 搜索. 搜索结果:

*   在文件名中找到的结果显示在内容中之前.
*   可能包含同一 blob 的多个匹配项,因为可能在文件名和内容中都找到了搜索字符串,或者在内容中可能出现了多次.

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature" 
```

响应示例:

```
 [  {  "basename":  "README",  "data":  "```\n\n## Installation\n\nQuick start using the [pre-built",  "path":  "README.md",  "filename":  "README.md",  "id":  null,  "ref":  "feature",  "startline":  46,  "project_id":  6  }  ] 
```

**注意:**不建议使用`filename`而推荐使用`path` . 两者都返回存储库中文件的完整路径,但将来`filename`名将仅是文件名,而不是完整路径. 有关详细信息,请参见[问题 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521) .

### Scope: users[](#scope-users-2 "Permalink")

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe" 
```

响应示例:

```
[  {  "id":  1,  "name":  "John Doe1",  "username":  "user1",  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",  "web_url":  "http://localhost/user1"  }  ] 
```