Repository navigation
Commit 7565bf0
committed
chore: added docs for search scopes constants
1 parent 9baa905 commit 7565bf0
2 files changed
Lines changed: 40 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,7 +4,45 @@ Search API | |||
| 4 | 4 | ||
| 5 | 5 | You can search for resources at the top level, in a project or in a group. | |
| 6 | 6 | 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 | + | ||
| 8 | 46 | ||
| 9 | 47 | Reference | |
| 10 | 48 | --------- | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -34,6 +34,7 @@ | |||
| 34 | 34 | NOTIFICATION_LEVEL_MENTION = "mention" | |
| 35 | 35 | NOTIFICATION_LEVEL_CUSTOM = "custom" | |
| 36 | 36 | ||
| 37 | + # Search scopes | ||
| 37 | 38 | _SEARCH_SCOPE_PROJECTS = "projects" | |
| 38 | 39 | _SEARCH_SCOPE_ISSUES = "issues" | |
| 39 | 40 | _SEARCH_SCOPE_MERGE_REQUESTS = "merge_requests" | |
0 commit comments