summaryrefslogtreecommitdiff
path: root/docs/gl_objects/search.rst
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-01 01:04:53 +0100
committerGitHub <noreply@github.com>2021-12-01 01:04:53 +0100
commit8d76826fa64460e504acc5924f859f8dbc246b42 (patch)
tree083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/search.rst
parent5a1678f43184bd459132102cc13cf8426fe0449d (diff)
parent86ab04e54ea4175f10053decfad5086cda7aa024 (diff)
downloadgitlab-master.tar.gz
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/search.rst')
-rw-r--r--docs/gl_objects/search.rst77
1 files changed, 0 insertions, 77 deletions
diff --git a/docs/gl_objects/search.rst b/docs/gl_objects/search.rst
deleted file mode 100644
index eb8ba80..0000000
--- a/docs/gl_objects/search.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-##########
-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. The following constants are provided to represent the possible scopes:
-
-
-* Shared scopes (global, group and project):
-
- + ``gitlab.SEARCH_SCOPE_PROJECTS``: ``projects``
- + ``gitlab.SEARCH_SCOPE_ISSUES``: ``issues``
- + ``gitlab.SEARCH_SCOPE_MERGE_REQUESTS``: ``merge_requests``
- + ``gitlab.SEARCH_SCOPE_MILESTONES``: ``milestones``
- + ``gitlab.SEARCH_SCOPE_WIKI_BLOBS``: ``wiki_blobs``
- + ``gitlab.SEARCH_SCOPE_COMMITS``: ``commits``
- + ``gitlab.SEARCH_SCOPE_BLOBS``: ``blobs``
- + ``gitlab.SEARCH_SCOPE_USERS``: ``users``
-
-
-* specific global scope:
-
- + ``gitlab.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
-
-
-* specific project scope:
-
- + ``gitlab.SEARCH_SCOPE_PROJECT_NOTES``: ``notes``
-
-
-Reference
----------
-
-* v4 API:
-
- + :attr:`gitlab.Gitlab.search`
- + :attr:`gitlab.v4.objects.Group.search`
- + :attr:`gitlab.v4.objects.Project.search`
-
-* GitLab API: https://docs.gitlab.com/ce/api/search.html
-
-Examples
---------
-
-Search for issues matching a specific string::
-
- # global search
- gl.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
-
- # group search
- group = gl.groups.get('mygroup')
- group.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
-
- # project search
- project = gl.projects.get('myproject')
- project.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
-
-The ``search()`` methods implement the pagination support::
-
- # get lists of 10 items, and start at page 2
- gl.search(gitlab.SEARCH_SCOPE_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(gitlab.SEARCH_SCOPE_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(gitlab.SEARCH_SCOPE_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()
-