Fix grammar and spelling
This commit is contained in:
parent
d32aec06fe
commit
40198f8184
|
@ -18,7 +18,7 @@
|
||||||
# assignee_id: integer or 'None' or 'Any'
|
# assignee_id: integer or 'None' or 'Any'
|
||||||
# assignee_username: string
|
# assignee_username: string
|
||||||
# search: string
|
# search: string
|
||||||
# in: 'title', 'description' or a string joined them with comma
|
# in: 'title', 'description', or a string joining them with comma
|
||||||
# label_name: string
|
# label_name: string
|
||||||
# sort: string
|
# sort: string
|
||||||
# non_archived: boolean
|
# non_archived: boolean
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
# milestone_title: string
|
# milestone_title: string
|
||||||
# assignee_id: integer
|
# assignee_id: integer
|
||||||
# search: string
|
# search: string
|
||||||
# in: 'title', 'description' or a string joined them with comma
|
# in: 'title', 'description', or a string joining them with comma
|
||||||
# label_name: string
|
# label_name: string
|
||||||
# sort: string
|
# sort: string
|
||||||
# my_reaction_emoji: string
|
# my_reaction_emoji: string
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
# author_id: integer
|
# author_id: integer
|
||||||
# assignee_id: integer
|
# assignee_id: integer
|
||||||
# search: string
|
# search: string
|
||||||
# in: 'title', 'description' or a string joined them with comma
|
# in: 'title', 'description', or a string joining them with comma
|
||||||
# label_name: string
|
# label_name: string
|
||||||
# sort: string
|
# sort: string
|
||||||
# non_archived: boolean
|
# non_archived: boolean
|
||||||
|
|
|
@ -47,7 +47,7 @@ GET /issues?search=foo&in=title
|
||||||
| `order_by` | string | no | Return issues ordered by `created_at` or `updated_at` fields. Default is `created_at` |
|
| `order_by` | string | no | Return issues ordered by `created_at` or `updated_at` fields. Default is `created_at` |
|
||||||
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
|
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
|
||||||
| `search` | string | no | Search issues against their `title` and `description` |
|
| `search` | string | no | Search issues against their `title` and `description` |
|
||||||
| `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joined them with comma. Default is `title,description` |
|
| `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` |
|
||||||
| `created_after` | datetime | no | Return issues created on or after the given time |
|
| `created_after` | datetime | no | Return issues created on or after the given time |
|
||||||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||||
|
|
|
@ -48,7 +48,7 @@ Parameters:
|
||||||
| `source_branch` | string | no | Return merge requests with the given source branch |
|
| `source_branch` | string | no | Return merge requests with the given source branch |
|
||||||
| `target_branch` | string | no | Return merge requests with the given target branch |
|
| `target_branch` | string | no | Return merge requests with the given target branch |
|
||||||
| `search` | string | no | Search merge requests against their `title` and `description` |
|
| `search` | string | no | Search merge requests against their `title` and `description` |
|
||||||
| `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joined them with comma. Default is `title,description` |
|
| `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` |
|
||||||
| `wip` | string | no | Filter merge requests against their `wip` status. `yes` to return *only* WIP merge requests, `no` to return *non* WIP merge requests |
|
| `wip` | string | no | Filter merge requests against their `wip` status. `yes` to return *only* WIP merge requests, `no` to return *non* WIP merge requests |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
|
|
@ -43,8 +43,8 @@ module API
|
||||||
desc: 'Return issues sorted in `asc` or `desc` order.'
|
desc: 'Return issues sorted in `asc` or `desc` order.'
|
||||||
optional :milestone, type: String, desc: 'Return issues for a specific milestone'
|
optional :milestone, type: String, desc: 'Return issues for a specific milestone'
|
||||||
optional :iids, type: Array[Integer], desc: 'The IID array of issues'
|
optional :iids, type: Array[Integer], desc: 'The IID array of issues'
|
||||||
optional :search, type: String, desc: 'Search issues for text present in the title, description or any combination of these'
|
optional :search, type: String, desc: 'Search issues for text present in the title, description, or any combination of these'
|
||||||
optional :in, type: String, desc: '`title`, `description` or a string joined them with comma'
|
optional :in, type: String, desc: '`title`, `description`, or a string joining them with comma'
|
||||||
optional :created_after, type: DateTime, desc: 'Return issues created after the specified time'
|
optional :created_after, type: DateTime, desc: 'Return issues created after the specified time'
|
||||||
optional :created_before, type: DateTime, desc: 'Return issues created before the specified time'
|
optional :created_before, type: DateTime, desc: 'Return issues created before the specified time'
|
||||||
optional :updated_after, type: DateTime, desc: 'Return issues updated after the specified time'
|
optional :updated_after, type: DateTime, desc: 'Return issues updated after the specified time'
|
||||||
|
|
|
@ -109,8 +109,8 @@ module API
|
||||||
optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
|
optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
|
||||||
optional :source_branch, type: String, desc: 'Return merge requests with the given source branch'
|
optional :source_branch, type: String, desc: 'Return merge requests with the given source branch'
|
||||||
optional :target_branch, type: String, desc: 'Return merge requests with the given target branch'
|
optional :target_branch, type: String, desc: 'Return merge requests with the given target branch'
|
||||||
optional :search, type: String, desc: 'Search merge requests for text present in the title, description or any combination of these'
|
optional :search, type: String, desc: 'Search merge requests for text present in the title, description, or any combination of these'
|
||||||
optional :in, type: String, desc: '`title`, `description` or a string joined them with comma'
|
optional :in, type: String, desc: '`title`, `description`, or a string joining them with comma'
|
||||||
optional :wip, type: String, values: %w[yes no], desc: 'Search merge requests for WIP in the title'
|
optional :wip, type: String, values: %w[yes no], desc: 'Search merge requests for WIP in the title'
|
||||||
use :pagination
|
use :pagination
|
||||||
end
|
end
|
||||||
|
|
|
@ -140,7 +140,7 @@ describe Issuable do
|
||||||
expect(issuable_class.full_search(searchable_issue2.description.downcase)).to eq([searchable_issue2])
|
expect(issuable_class.full_search(searchable_issue2.description.downcase)).to eq([searchable_issue2])
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is "title"' do
|
context 'when matching columns is "title"' do
|
||||||
it 'returns issues with a matching title' do
|
it 'returns issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title'))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title'))
|
||||||
.to eq([searchable_issue])
|
.to eq([searchable_issue])
|
||||||
|
@ -152,7 +152,7 @@ describe Issuable do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is "description"' do
|
context 'when matching columns is "description"' do
|
||||||
it 'returns no issues with a matching title' do
|
it 'returns no issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'description'))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'description'))
|
||||||
.to be_empty
|
.to be_empty
|
||||||
|
@ -164,7 +164,7 @@ describe Issuable do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is "title,description"' do
|
context 'when matching columns is "title,description"' do
|
||||||
it 'returns issues with a matching title' do
|
it 'returns issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,description'))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,description'))
|
||||||
.to eq([searchable_issue])
|
.to eq([searchable_issue])
|
||||||
|
@ -176,7 +176,7 @@ describe Issuable do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is nil"' do
|
context 'when matching columns is nil"' do
|
||||||
it 'returns issues with a matching title' do
|
it 'returns issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: nil))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: nil))
|
||||||
.to eq([searchable_issue])
|
.to eq([searchable_issue])
|
||||||
|
@ -188,7 +188,7 @@ describe Issuable do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is "invalid"' do
|
context 'when matching columns is "invalid"' do
|
||||||
it 'returns issues with a matching title' do
|
it 'returns issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'invalid'))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'invalid'))
|
||||||
.to eq([searchable_issue])
|
.to eq([searchable_issue])
|
||||||
|
@ -200,7 +200,7 @@ describe Issuable do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when mathing columns is "title,invalid"' do
|
context 'when matching columns is "title,invalid"' do
|
||||||
it 'returns issues with a matching title' do
|
it 'returns issues with a matching title' do
|
||||||
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,invalid'))
|
expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,invalid'))
|
||||||
.to eq([searchable_issue])
|
.to eq([searchable_issue])
|
||||||
|
|
Loading…
Reference in New Issue