Commit 86e98c83 authored by Jarka Kadlecová's avatar Jarka Kadlecová

Small code/doc changes

parent f170913d
...@@ -17,7 +17,7 @@ GET /search ...@@ -17,7 +17,7 @@ GET /search
| `scope` | string | yes | The scope to search in | | `scope` | string | yes | The scope to search in |
| `search` | string | yes | The search query | | `search` | string | yes | The search query |
Search the expression within the specified scope. Currentyly these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs. Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs.
The response depends on the requested scope. The response depends on the requested scope.
...@@ -298,7 +298,7 @@ GET /groups/:id/-/search ...@@ -298,7 +298,7 @@ GET /groups/:id/-/search
| `scope` | string | yes | The scope to search in | | `scope` | string | yes | The scope to search in |
| `search` | string | yes | The search query | | `search` | string | yes | The search query |
Search the expression within the specified scope. Currentyly these scopes are supported: projects, issues, merge_requests, milestones. Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones.
The response depends on the requested scope. The response depends on the requested scope.
...@@ -512,11 +512,11 @@ GET /projects/:id/-/search ...@@ -512,11 +512,11 @@ GET /projects/:id/-/search
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `scope` | string | yes | The scope to search in | | `scope` | string | yes | The scope to search in |
| `search` | string | yes | The search query | | `search` | string | yes | The search query |
Search the expression within the specified scope. Currentyly these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs. Search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs.
The response depends on the requested scope. The response depends on the requested scope.
......
...@@ -58,8 +58,10 @@ module API ...@@ -58,8 +58,10 @@ module API
end end
params do params do
requires :search, type: String, desc: 'The expression it should be searched for' requires :search, type: String, desc: 'The expression it should be searched for'
requires :scope, type: String, desc: 'The scope of search, available scopes: requires :scope,
projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs', type: String,
desc: 'The scope of search, available scopes:
projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs',
values: %w(projects issues merge_requests milestones snippet_titles snippet_blobs) values: %w(projects issues merge_requests milestones snippet_titles snippet_blobs)
use :pagination use :pagination
end end
...@@ -75,8 +77,10 @@ module API ...@@ -75,8 +77,10 @@ module API
params do params do
requires :id, type: String, desc: 'The ID of a group' requires :id, type: String, desc: 'The ID of a group'
requires :search, type: String, desc: 'The expression it should be searched for' requires :search, type: String, desc: 'The expression it should be searched for'
requires :scope, type: String, desc: 'The scope of search, available scopes: requires :scope,
projects, issues, merge_requests, milestones', type: String,
desc: 'The scope of search, available scopes:
projects, issues, merge_requests, milestones',
values: %w(projects issues merge_requests milestones) values: %w(projects issues merge_requests milestones)
use :pagination use :pagination
end end
...@@ -94,8 +98,10 @@ module API ...@@ -94,8 +98,10 @@ module API
params do params do
requires :id, type: String, desc: 'The ID of a project' requires :id, type: String, desc: 'The ID of a project'
requires :search, type: String, desc: 'The expression it should be searched for' requires :search, type: String, desc: 'The expression it should be searched for'
requires :scope, type: String, desc: 'The scope of search, available scopes: requires :scope,
issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs', type: String,
desc: 'The scope of search, available scopes:
issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs',
values: %w(issues merge_requests milestones notes wiki_blobs commits blobs) values: %w(issues merge_requests milestones notes wiki_blobs commits blobs)
use :pagination use :pagination
end end
......
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