Skip to content

Commit 650b65c

Browse files
fix: docs changed using the consts
1 parent 7565bf0 commit 650b65c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/gl_objects/search.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,31 +61,32 @@ Examples
6161
Search for issues matching a specific string::
6262

6363
# global search
64-
gl.search('issues', 'regression')
64+
gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, 'regression')
6565

6666
# group search
6767
group = gl.groups.get('mygroup')
68-
group.search('issues', 'regression')
68+
group.search(gitlab.SEARCH_SCOPE_GROUP_ISSUES, 'regression')
6969

7070
# project search
7171
project = gl.projects.get('myproject')
72-
project.search('issues', 'regression')
72+
project.search(gitlab.SEARCH_SCOPE_PROJECT_ISSUES, 'regression')
7373

7474
The ``search()`` methods implement the pagination support::
7575

7676
# get lists of 10 items, and start at page 2
77-
gl.search('issues', search_str, page=2, per_page=10)
77+
gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, page=2, per_page=10)
7878

7979
# get a generator that will automatically make required API calls for
8080
# pagination
81-
for item in gl.search('issues', search_str, as_list=False):
81+
for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, as_list=False):
8282
do_something(item)
8383

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

87-
for item in gl.search('issues', search_str, as_list=False):
87+
for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, as_list=False):
8888
issue_project = gl.projects.get(item['project_id'], lazy=True)
8989
issue = issue_project.issues.get(item['iid'])
9090
issue.state = 'closed'
9191
issue.save()
92+

0 commit comments

Comments
 (0)