diff options
| author | Jan Provaznik <jprovaznik@gitlab.com> | 2018-12-07 09:50:23 +0100 |
|---|---|---|
| committer | Jan Provaznik <jprovaznik@gitlab.com> | 2018-12-07 13:26:24 +0100 |
| commit | 6f464cf074f547d370441c3c9ec32e6829476da0 (patch) | |
| tree | df2870d2036078edf0a0d74d9cb7d04517d5350f | |
| parent | a2e06ad3034cd1e007b78514a5c1f47feef7b648 (diff) | |
| download | gitlab-ce-6f464cf074f547d370441c3c9ec32e6829476da0.tar.gz | |
Fix minor issues in search API doc
| -rw-r--r-- | doc/api/search.md | 28 |
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 |