diff options
Diffstat (limited to 'doc/api/search.md')
| -rw-r--r-- | doc/api/search.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/search.md b/doc/api/search.md index 2969cf439dd..8c681904e98 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -27,7 +27,7 @@ GET /search | `order_by` | string | no | Allowed values are `created_at` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| | `sort` | string | no | Allowed values are `asc` or `desc` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| -Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, users. +Search the expression in the specified scope. These scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, users. If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(PREMIUM)** @@ -344,7 +344,7 @@ Filters are available for this scope: - path - extension -to use a filter simply include it in your query like so: `a query filename:some_name*`. +To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. @@ -432,7 +432,7 @@ Example response: ## Group Search API -Search within the specified group. +Search in the specified group. If a user is not a member of a group and the group is private, a `GET` request on that group results in a `404` status code. @@ -450,7 +450,7 @@ GET /groups/:id/search | `order_by` | string | no | Allowed values are `created_at` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| | `sort` | string | no | Allowed values are `asc` or `desc` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| -Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users. +Search the expression in the specified scope. These scopes are supported: projects, issues, merge_requests, milestones, users. If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(PREMIUM)** @@ -736,7 +736,7 @@ Filters are available for this scope: - path - extension -to use a filter simply include it in your query like so: `a query filename:some_name*`. +To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. @@ -824,7 +824,7 @@ Example response: ## Project Search API -Search within the specified project. +Search in the specified project. If a user is not a member of a project and the project is private, a `GET` request on that project results in a `404` status code. @@ -843,7 +843,7 @@ GET /projects/:id/search | `order_by` | string | no | Allowed values are `created_at` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| | `sort` | string | no | Allowed values are `asc` or `desc` only. If this is not set, the results are either sorted by `created_at` in descending order for basic search, or by the most relevant documents when using advanced search.| -Search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users. +Search the expression in the specified scope. These scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users. The response depends on the requested scope. @@ -1065,7 +1065,7 @@ Filters are available for this scope: - path - extension -To use a filter simply include it in your query like: `a query filename:some_name*`. +To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. Wiki blobs searches are performed on both filenames and contents. Search @@ -1148,7 +1148,7 @@ Filters are available for this scope: - path - extension -To use a filter simply include it in your query like: `a query filename:some_name*`. +To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. Blobs searches are performed on both filenames and contents. Search results: |