summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-12-07 13:42:52 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2018-12-07 13:42:52 +0000
commit25cd8fb5471ed32c6ce565e2a1027f591091f19f (patch)
tree905879fd16caae227540bb9e71fc775d077764f8 /doc/api
parent9ed1c2b5526eff78b27043f0b73ca0368dd4660f (diff)
parent6f464cf074f547d370441c3c9ec32e6829476da0 (diff)
downloadgitlab-ce-25cd8fb5471ed32c6ce565e2a1027f591091f19f.tar.gz
Merge branch 'docs-search' into 'master'
[Documentation] Fix minor issues in search API doc Closes #54959 See merge request gitlab-org/gitlab-ce!23645
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/search.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/doc/api/search.md b/doc/api/search.md
index a9369930003..7e3ae7404a3 100644
--- a/doc/api/search.md
+++ b/doc/api/search.md
@@ -722,16 +722,22 @@ Example response:
### Scope: wiki_blobs
+Filters are available for this scope:
+
+- filename
+- path
+- extension
+
+To use a filter simply include it in your query like: `a query filename:some_name*`.
+You may use wildcards (`*`) to use glob matching.
+
Wiki blobs searches are performed on both filenames and contents. Search
results:
- Found in filenames are displayed before results found in contents.
- May contain multiple matches for the same blob because the search string
- might be found in both the filename and content, and matches of the different
-types are displayed separately.
-- May contain multiple matches for the same blob because the search string
- might be found if the search string appears multiple times in the content.
-
+ might be found in both the filename and content, or might appear multiple
+ times in the content.
```bash
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye
@@ -788,22 +794,20 @@ Example response:
### Scope: blobs
Filters are available for this scope:
+
- filename
- path
- extension
-to use a filter simply include it in your query like so: `a query filename:some_name*`.
+To use a filter simply include it in your query like: `a query filename:some_name*`.
+You may use wildcards (`*`) to use glob matching.
Blobs searches are performed on both filenames and contents. Search results:
- Found in filenames are displayed before results found in contents.
- May contain multiple matches for the same blob because the search string
- might be found in both the filename and content, and matches of the different
-types are displayed separately.
-- May contain multiple matches for the same blob because the search string
- might be found if the search string appears multiple times in the content.
-
-You may use wildcards (`*`) to use glob matching.
+ might be found in both the filename and content, or might appear multiple
+ times in the content.
```bash
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation