diff --git a/app/finders/issuable_finder.rb b/app/finders/issuable_finder.rb index 8984cef42e9..3e08c0ccd8f 100644 --- a/app/finders/issuable_finder.rb +++ b/app/finders/issuable_finder.rb @@ -18,7 +18,7 @@ # assignee_id: integer or 'None' or 'Any' # assignee_username: 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 # sort: string # non_archived: boolean diff --git a/app/finders/issues_finder.rb b/app/finders/issues_finder.rb index bf39effa265..a0504ca0879 100644 --- a/app/finders/issues_finder.rb +++ b/app/finders/issues_finder.rb @@ -14,7 +14,7 @@ # milestone_title: string # assignee_id: integer # 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 # sort: string # my_reaction_emoji: string diff --git a/app/finders/merge_requests_finder.rb b/app/finders/merge_requests_finder.rb index 3cfe9533bb6..b645011a3c5 100644 --- a/app/finders/merge_requests_finder.rb +++ b/app/finders/merge_requests_finder.rb @@ -15,7 +15,7 @@ # author_id: integer # assignee_id: integer # 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 # sort: string # non_archived: boolean diff --git a/doc/api/issues.md b/doc/api/issues.md index b86340bb5e7..47635579e13 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -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` | | `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` | | `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_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 | diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index c351be5bd55..515aad49b29 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -48,7 +48,7 @@ Parameters: | `source_branch` | string | no | Return merge requests with the given source branch | | `target_branch` | string | no | Return merge requests with the given target branch | | `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 | ```json diff --git a/lib/api/issues.rb b/lib/api/issues.rb index a797f01e89f..6e7984e77cc 100644 --- a/lib/api/issues.rb +++ b/lib/api/issues.rb @@ -43,8 +43,8 @@ module API desc: 'Return issues sorted in `asc` or `desc` order.' optional :milestone, type: String, desc: 'Return issues for a specific milestone' 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 :in, type: String, desc: '`title`, `description` or a string joined them with comma' + 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 joining them with comma' 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 :updated_after, type: DateTime, desc: 'Return issues updated after the specified time' diff --git a/lib/api/merge_requests.rb b/lib/api/merge_requests.rb index 991b7310cfd..163720a54c5 100644 --- a/lib/api/merge_requests.rb +++ b/lib/api/merge_requests.rb @@ -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 :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 :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 :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 joining them with comma' optional :wip, type: String, values: %w[yes no], desc: 'Search merge requests for WIP in the title' use :pagination end diff --git a/spec/models/concerns/issuable_spec.rb b/spec/models/concerns/issuable_spec.rb index d7003cdb760..44c946be23f 100644 --- a/spec/models/concerns/issuable_spec.rb +++ b/spec/models/concerns/issuable_spec.rb @@ -140,7 +140,7 @@ describe Issuable do expect(issuable_class.full_search(searchable_issue2.description.downcase)).to eq([searchable_issue2]) end - context 'when mathing columns is "title"' do + context 'when matching columns is "title"' do it 'returns issues with a matching title' do expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title')) .to eq([searchable_issue]) @@ -152,7 +152,7 @@ describe Issuable do 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 expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'description')) .to be_empty @@ -164,7 +164,7 @@ describe Issuable do 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 expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,description')) .to eq([searchable_issue]) @@ -176,7 +176,7 @@ describe Issuable do end end - context 'when mathing columns is nil"' do + context 'when matching columns is nil"' do it 'returns issues with a matching title' do expect(issuable_class.full_search(searchable_issue.title, matched_columns: nil)) .to eq([searchable_issue]) @@ -188,7 +188,7 @@ describe Issuable do end end - context 'when mathing columns is "invalid"' do + context 'when matching columns is "invalid"' do it 'returns issues with a matching title' do expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'invalid')) .to eq([searchable_issue]) @@ -200,7 +200,7 @@ describe Issuable do 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 expect(issuable_class.full_search(searchable_issue.title, matched_columns: 'title,invalid')) .to eq([searchable_issue])