diff options
Diffstat (limited to 'doc/api/search.md')
-rw-r--r-- | doc/api/search.md | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/api/search.md b/doc/api/search.md index 46209fb753f..bac259651f8 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -25,7 +25,7 @@ The response depends on the requested scope. ### Scope: projects -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=projects&search=flight ``` @@ -56,7 +56,7 @@ Example response: ### Scope: issues -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=issues&search=file ``` @@ -121,7 +121,7 @@ Example response: ### Scope: merge_requests -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file ``` @@ -199,7 +199,7 @@ Example response: ### Scope: milestones -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=milestones&search=release ``` @@ -224,7 +224,7 @@ Example response: ### Scope: snippet_titles -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample ``` @@ -255,7 +255,7 @@ Example response: ### Scope: snippet_blobs -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=snippet_blobs&search=test ``` @@ -288,7 +288,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye ``` @@ -316,7 +316,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=commits&search=bye ``` @@ -359,7 +359,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ You may use wildcards (`*`) to use glob matching. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=blobs&search=installation ``` @@ -385,7 +385,7 @@ Example response: ### Scope: users -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=users&search=doe ``` @@ -428,7 +428,7 @@ The response depends on the requested scope. ### Scope: projects -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight ``` @@ -459,7 +459,7 @@ Example response: ### Scope: issues -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file ``` @@ -524,7 +524,7 @@ Example response: ### Scope: merge_requests -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file ``` @@ -602,7 +602,7 @@ Example response: ### Scope: milestones -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release ``` @@ -629,7 +629,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye ``` @@ -657,7 +657,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye ``` @@ -700,7 +700,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ You may use wildcards (`*`) to use glob matching. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation ``` @@ -726,7 +726,7 @@ Example response: ### Scope: users -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe ``` @@ -768,7 +768,7 @@ The response depends on the requested scope. ### Scope: issues -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file ``` @@ -833,7 +833,7 @@ Example response: ### Scope: merge_requests -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file ``` @@ -911,7 +911,7 @@ Example response: ### Scope: milestones -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release ``` @@ -936,7 +936,7 @@ Example response: ### Scope: notes -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime ``` @@ -985,7 +985,7 @@ results: might be found in both the filename and content, or might appear multiple times in the content. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye ``` @@ -1011,7 +1011,7 @@ Example response: ### Scope: commits -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye ``` @@ -1058,7 +1058,7 @@ Blobs searches are performed on both filenames and contents. Search results: might be found in both the filename and content, or might appear multiple times in the content. -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature ``` @@ -1084,7 +1084,7 @@ Example response: ### Scope: users -```bash +```shell curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe ``` |