From 6a5b63e4c9405d744abda67ac1e6e54ca56e9a15 Mon Sep 17 00:00:00 2001 From: Jonathan Schafer <jschafer@gitlab.com> Date: Fri, 11 Jun 2021 14:38:28 -0500 Subject: [PATCH] Add descriptions for EpicStateEnum Changelog: changed EE: true --- .rubocop_manual_todo.yml | 1 - doc/api/graphql/reference/index.md | 6 +++--- ee/app/graphql/types/epic_state_enum.rb | 6 +++--- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.rubocop_manual_todo.yml b/.rubocop_manual_todo.yml index dae8084b656c..0541a788c67d 100644 --- a/.rubocop_manual_todo.yml +++ b/.rubocop_manual_todo.yml @@ -13,7 +13,6 @@ # WIP See https://gitlab.com/gitlab-org/gitlab/-/issues/322903 Graphql/Descriptions: Exclude: - - 'ee/app/graphql/types/epic_state_enum.rb' - 'ee/app/graphql/types/health_status_enum.rb' - 'ee/app/graphql/types/iteration_state_enum.rb' - 'ee/app/graphql/types/requirements_management/requirement_state_enum.rb' diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 2d775fcf83d0..b51ae3e09f87 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -14245,9 +14245,9 @@ State of an epic. | Value | Description | | ----- | ----------- | -| <a id="epicstateall"></a>`all` | | -| <a id="epicstateclosed"></a>`closed` | | -| <a id="epicstateopened"></a>`opened` | | +| <a id="epicstateall"></a>`all` | All epics. | +| <a id="epicstateclosed"></a>`closed` | Closed epics. | +| <a id="epicstateopened"></a>`opened` | Open epics. | ### `EpicStateEvent` diff --git a/ee/app/graphql/types/epic_state_enum.rb b/ee/app/graphql/types/epic_state_enum.rb index c55c332b04e0..9ff0d0eb027e 100644 --- a/ee/app/graphql/types/epic_state_enum.rb +++ b/ee/app/graphql/types/epic_state_enum.rb @@ -5,8 +5,8 @@ class EpicStateEnum < BaseEnum graphql_name 'EpicState' description 'State of an epic' - value 'all' - value 'opened' - value 'closed' + value 'all', description: 'All epics.' + value 'opened', description: 'Open epics.' + value 'closed', description: 'Closed epics.' end end -- GitLab