diff options
| author | Valentin Grégoire <valentin.gregoire@basf.com> | 2020-09-16 22:04:53 +0200 |
|---|---|---|
| committer | Valentin Grégoire <valentin.gregoire@basf.com> | 2020-09-16 22:04:53 +0200 |
| commit | 650b65c389c686bcc9a9cef81b6ca2a509d8cad2 (patch) | |
| tree | bc88bdd728c0abab27295b51be1d78d9dd3c987c | |
| parent | 7565bf059b240c9fffaf6959ee168a12d0fedd77 (diff) | |
| download | gitlab-650b65c389c686bcc9a9cef81b6ca2a509d8cad2.tar.gz | |
fix: docs changed using the consts
| -rw-r--r-- | docs/gl_objects/search.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/gl_objects/search.rst b/docs/gl_objects/search.rst index e7ba5d7..283589e 100644 --- a/docs/gl_objects/search.rst +++ b/docs/gl_objects/search.rst @@ -61,31 +61,32 @@ Examples Search for issues matching a specific string:: # global search - gl.search('issues', 'regression') + gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, 'regression') # group search group = gl.groups.get('mygroup') - group.search('issues', 'regression') + group.search(gitlab.SEARCH_SCOPE_GROUP_ISSUES, 'regression') # project search project = gl.projects.get('myproject') - project.search('issues', 'regression') + project.search(gitlab.SEARCH_SCOPE_PROJECT_ISSUES, 'regression') The ``search()`` methods implement the pagination support:: # get lists of 10 items, and start at page 2 - gl.search('issues', search_str, page=2, per_page=10) + gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, page=2, per_page=10) # get a generator that will automatically make required API calls for # pagination - for item in gl.search('issues', search_str, as_list=False): + for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, as_list=False): do_something(item) 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 gl.search('issues', search_str, as_list=False): + for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_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' issue.save() + |