Commit 25cd8fb5 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-search' into 'master'

[Documentation] Fix minor issues in search API doc

Closes #54959

See merge request gitlab-org/gitlab-ce!23645
parents 9ed1c2b5 6f464cf0
...@@ -722,16 +722,22 @@ Example response: ...@@ -722,16 +722,22 @@ Example response:
### Scope: wiki_blobs ### 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 Wiki blobs searches are performed on both filenames and contents. Search
results: results:
- Found in filenames are displayed before results found in contents. - Found in filenames are displayed before results found in contents.
- May contain multiple matches for the same blob because the search string - 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 might be found in both the filename and content, or might appear multiple
types are displayed separately. times in the content.
- 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.
```bash ```bash
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye 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: ...@@ -788,22 +794,20 @@ Example response:
### Scope: blobs ### Scope: blobs
Filters are available for this scope: Filters are available for this scope:
- filename - filename
- path - path
- extension - 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: Blobs searches are performed on both filenames and contents. Search results:
- Found in filenames are displayed before results found in contents. - Found in filenames are displayed before results found in contents.
- May contain multiple matches for the same blob because the search string - 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 might be found in both the filename and content, or might appear multiple
types are displayed separately. times in the content.
- 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.
```bash ```bash
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment