Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit7565bf0

Browse files
chore: added docs for search scopes constants
1 parent9baa905 commit7565bf0

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

‎docs/gl_objects/search.rst‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,45 @@ Search API
44

55
You can search for resources at the top level, in a project or in a group.
66
Searches are based on a scope (issues, merge requests, and so on) and a search
7-
string.
7+
string. The following constants are provided to represent the possible scopes:
8+
9+
10+
* global scopes:
11+
12+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_PROJECTS``: ``projects``
13+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_ISSUES``: ``issues``
14+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_MERGE_REQUESTS``: ``merge_requests``
15+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_MILESTONES``: ``milestones``
16+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
17+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_WIKI_BLOBS``: ``wiki_blobs``
18+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_COMMITS``: ``commits``
19+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_BLOBS``: ``blobs``
20+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_USERS``: ``users``
21+
22+
23+
* group scopes:
24+
25+
+ ``gitlab.SEARCH_SCOPE_GROUP_PROJECTS``: ``projects``
26+
+ ``gitlab.SEARCH_SCOPE_GROUP_ISSUES``: ``issues``
27+
+ ``gitlab.SEARCH_SCOPE_GROUP_MERGE_REQUESTS``: ``merge_requests``
28+
+ ``gitlab.SEARCH_SCOPE_GROUP_MILESTONES``: ``milestones``
29+
+ ``gitlab.SEARCH_SCOPE_GROUP_WIKI_BLOBS``: ``wiki_blobs``
30+
+ ``gitlab.SEARCH_SCOPE_GROUP_COMMITS``: ``commits``
31+
+ ``gitlab.SEARCH_SCOPE_GROUP_BLOBS``: ``blobs``
32+
+ ``gitlab.SEARCH_SCOPE_GROUP_USERS``: ``users``
33+
34+
35+
* project scopes:
36+
37+
+ ``gitlab.SEARCH_SCOPE_PROJECT_ISSUES``: ``issues``
38+
+ ``gitlab.SEARCH_SCOPE_PROJECT_MERGE_REQUESTS``: ``merge_requests``
39+
+ ``gitlab.SEARCH_SCOPE_PROJECT_MILESTONES``: ``milestones``
40+
+ ``gitlab.SEARCH_SCOPE_PROJECT_NOTES``: ``notes``
41+
+ ``gitlab.SEARCH_SCOPE_PROJECT_WIKI_BLOBS``: ``wiki_blobs``
42+
+ ``gitlab.SEARCH_SCOPE_PROJECT_COMMITS``: ``commits``
43+
+ ``gitlab.SEARCH_SCOPE_PROJECT_BLOBS``: ``blobs``
44+
+ ``gitlab.SEARCH_SCOPE_PROJECT_USERS``: ``users``
45+
846

947
Reference
1048
---------

‎gitlab/const.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
NOTIFICATION_LEVEL_MENTION="mention"
3535
NOTIFICATION_LEVEL_CUSTOM="custom"
3636

37+
# Search scopes
3738
_SEARCH_SCOPE_PROJECTS="projects"
3839
_SEARCH_SCOPE_ISSUES="issues"
3940
_SEARCH_SCOPE_MERGE_REQUESTS="merge_requests"

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp