Search API

You can search for resources at the top level, in a project or in a group. Searches are based on a scope (issues, merge requests, and so on) and a search string.


Search for issues matching a specific string:

# global search'issues', 'regression')

# group search
group = gl.groups.get('mygroup')'issues', 'regression')

# project search
project = gl.projects.get('myproject')'issues', 'regression')

The search() methods implement the pagination support:

# get lists of 10 items, and start at page 2'issues', search_str, page=2, per_page=10)

# get a generator that will automatically make required API calls for
# pagination
for item in'issues', search_str, as_list=False):

The search API doesn’t return objects, but dicts. If you need to act on objects, you need to create them explicitly:

for item in'issues', search_str, as_list=False):
    issue_project = gl.projects.get(item['project_id'], lazy=True)
    issue = issue_project.issues.get(item['iid'])
    issue.state = 'closed'