Update docs and API descriptions to reflect negated field changes

e975f8a7 · Mario Sebastián Celi Calderón · Mario Celi · 1ca8771b · e975f8a7 · e975f8a7
Commit e975f8a7 authored Mar 02, 2021 by Mario Sebastián Celi Calderón Committed by Mario Celi Mar 02, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 4 deletions

doc/api/issues.md doc/api/issues.md +1 -1

ee/lib/ee/api/helpers/issues_helpers.rb ee/lib/ee/api/helpers/issues_helpers.rb +1 -1

lib/api/issues.rb lib/api/issues.rb +2 -2

No files found.
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -67,7 +67,7 @@ GET /issues?state=opened
 | `milestone`         | string           | no         | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone.                             |
 | `my_reaction_emoji` | string           | no         | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ |
 | `non_archived`      | boolean          | no         | Return issues only from non-archived projects. If `false`, the response returns issues from both archived and non-archived projects. Default is `true`. _(Introduced in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/197170))_ |
-| `not`               | Hash             | no         | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `my_reaction_emoji` |
+| `not`               | Hash             | no         | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `iids` |
 | `order_by`          | string           | no         | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at`                                                               |
 | `scope`             | string           | no         | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5. [Changed to snake_case](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935) in GitLab 11.0)_ |
 | `search`            | string           | no         | Search issues against their `title` and `description`                                                                                               |

--- a/ee/lib/ee/api/helpers/issues_helpers.rb
+++ b/ee/lib/ee/api/helpers/issues_helpers.rb
@@ -18,7 +18,7 @@ module EE
            optional :weight, type: Integer, desc: 'Return issues without the specified weight'
            optional :iteration_id, types: [Integer, String],
                     integer_or_custom_value: ::Iteration::Predefined::ALL.map { |iteration| iteration.name.downcase },
-                     desc: 'Return issues which are assigned to the iteration with the given ID'
+                     desc: 'Return issues which are not assigned to the iteration with the given ID'
            optional :iteration_title, type: String,
                     desc: 'Return issues which are not assigned to the iteration with the given title'
            mutually_exclusive :iteration_id, :iteration_title

--- a/lib/api/issues.rb
+++ b/lib/api/issues.rb
@@ -20,10 +20,10 @@ module API
        optional :author_username, type: String, desc: 'Return issues which are not authored by the user with the given username'
        mutually_exclusive :author_id, :author_username

-        optional :assignee_id, type: Integer, desc: 'Return issues which are assigned to the user with the given ID'
+        optional :assignee_id, type: Integer, desc: 'Return issues which are not assigned to the user with the given ID'
        optional :assignee_username, type: Array[String], check_assignees_count: true,
                 coerce_with: Validations::Validators::CheckAssigneesCount.coerce,
-                 desc: 'Return issues which are assigned to the user with the given username'
+                 desc: 'Return issues which are not assigned to the user with the given username'
        mutually_exclusive :assignee_id, :assignee_username

        use :negatable_issue_filter_params_ee