Search¶
The search endpoints find repositories, issues, and users across the whole platform. There are both object-specific endpoints and one general endpoint that switches on type.
Objects¶
| Object | Description | Related endpoints |
|---|---|---|
| Repository | Search repositories by keyword | Search repositories |
| Issue | Search issues by keyword | Search Issues |
| User | Search users by keyword | Search users |
| General search | Specify the object with type; covers users, organizations, repositories, PRs, issues, commits, and wikis |
Search by type |
Identification¶
- The search target is given by query parameters. There are no path parameters, and all paths are under
/api/v5/search. - The general endpoint uses
typeto decide what to search; for the dedicated endpoints the object is already fixed in the path.
Common tasks¶
| Task | Endpoint |
|---|---|
| Search repositories | GET /api/v5/search/repositories |
| Search issues | GET /api/v5/search/issues |
| Search users | GET /api/v5/search/users |
| Search by type | GET /api/v5/search |
Notes¶
- The general endpoint is
GET /api/v5/search, which switches between object types via thetypeparameter. Use it when you need types such as user, organization, PR, commit, or wiki; the dedicated endpoints for repositories, issues, and users are more explicit. - The paths of the three dedicated endpoints are
/search/repositories,/search/issues, and/search/users(plural), which differ from the general endpoint by one path segment. - Pagination and sorting parameters are not identical across endpoints; pass them according to the parameter table of the specific endpoint page.
Endpoint list¶
This module contains 4 endpoints.
| # | Endpoint | Method and path | Description |
|---|---|---|---|
| 1 | Search users | GET /api/v5/search/users |
Call this endpoint to search users. |
| 2 | Search Issues | GET /api/v5/search/issues |
Call this endpoint to search issues. |
| 3 | Search repositories | GET /api/v5/search/repositories |
Call this endpoint to search repositories. |
| 4 | Search by type | GET /api/v5/search |
Search-by-type endpoint; you can use it to search users, organizations, repositories, PRs, issues, commits, wikis, and more |
Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc