Fix minor issues in search API doc
This commit is contained in:
parent
a2e06ad303
commit
6f464cf074
1 changed files with 16 additions and 12 deletions
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue