Merge branch '337596-fix-rubocop-offenses-10' into 'master'

Remove `Graphql/Description` from `.rubocop_manual_todo.yml`

See merge request gitlab-org/gitlab!69826

.rubocop_manual_todo.yml

@@ -10,20 +10,6 @@
 # - guidelines for use found in
 #   https://docs.gitlab.com/ee/development/contributing/style_guides.html#resolving-rubocop-exceptions.
 
-# WIP See https://gitlab.com/gitlab-org/gitlab/-/issues/337596
-Graphql/Descriptions:
-  Exclude:
-    - 'ee/app/graphql/types/iteration_state_enum.rb'
-    - 'ee/app/graphql/types/requirements_management/requirement_state_enum.rb'
-    - 'ee/app/graphql/types/requirements_management/test_report_state_enum.rb'
-    - 'ee/app/graphql/types/security_scanner_type_enum.rb'
-    - 'ee/app/graphql/types/vulnerability/issue_link_type_enum.rb'
-    - 'ee/app/graphql/types/vulnerability_grade_enum.rb'
-    - 'ee/app/graphql/types/vulnerability_report_type_enum.rb'
-    - 'ee/app/graphql/types/vulnerability_severity_enum.rb'
-    - 'ee/app/graphql/types/vulnerability_state_enum.rb'
-    - 'ee/app/graphql/types/vulnerability_confidence_enum.rb'
-
 # WIP: See https://gitlab.com/gitlab-org/gitlab/-/issues/220040
 Rails/SaveBang:
   Exclude:

doc/api/graphql/reference/index.md

@@ -15700,12 +15700,12 @@ State of a GitLab iteration.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="iterationstateall"></a>`all` |  |
-| <a id="iterationstateclosed"></a>`closed` |  |
-| <a id="iterationstatecurrent"></a>`current` |  |
-| <a id="iterationstateopened"></a>`opened` |  |
+| <a id="iterationstateall"></a>`all` | Any iteration. |
+| <a id="iterationstateclosed"></a>`closed` | Closed iteration. |
+| <a id="iterationstatecurrent"></a>`current` | Current iteration. |
+| <a id="iterationstateopened"></a>`opened` | Open iteration. |
 | <a id="iterationstatestarted"></a>`started` **{warning-solid}** | **Deprecated** in 14.1. Use current instead. |
-| <a id="iterationstateupcoming"></a>`upcoming` |  |
+| <a id="iterationstateupcoming"></a>`upcoming` | Upcoming iteration. |
 
 ### `IterationWildcardId`
 
@@ -16101,8 +16101,8 @@ State of a requirement.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="requirementstatearchived"></a>`ARCHIVED` |  |
-| <a id="requirementstateopened"></a>`OPENED` |  |
+| <a id="requirementstatearchived"></a>`ARCHIVED` | Archived requirement. |
+| <a id="requirementstateopened"></a>`OPENED` | Open requirement. |
 
 ### `RequirementStatusFilter`
 
@@ -16110,9 +16110,9 @@ Status of a requirement based on last test report.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="requirementstatusfilterfailed"></a>`FAILED` |  |
+| <a id="requirementstatusfilterfailed"></a>`FAILED` | Failed test report. |
 | <a id="requirementstatusfiltermissing"></a>`MISSING` | Requirements without any test report. |
-| <a id="requirementstatusfilterpassed"></a>`PASSED` |  |
+| <a id="requirementstatusfilterpassed"></a>`PASSED` | Passed test report. |
 
 ### `RunnerMembershipFilter`
 
@@ -16152,14 +16152,14 @@ The type of the security scanner.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="securityscannertypeapi_fuzzing"></a>`API_FUZZING` |  |
-| <a id="securityscannertypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` |  |
-| <a id="securityscannertypecontainer_scanning"></a>`CONTAINER_SCANNING` |  |
-| <a id="securityscannertypecoverage_fuzzing"></a>`COVERAGE_FUZZING` |  |
-| <a id="securityscannertypedast"></a>`DAST` |  |
-| <a id="securityscannertypedependency_scanning"></a>`DEPENDENCY_SCANNING` |  |
-| <a id="securityscannertypesast"></a>`SAST` |  |
-| <a id="securityscannertypesecret_detection"></a>`SECRET_DETECTION` |  |
+| <a id="securityscannertypeapi_fuzzing"></a>`API_FUZZING` | API Fuzzing scanner. |
+| <a id="securityscannertypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | Cluster Image Scanning scanner. |
+| <a id="securityscannertypecontainer_scanning"></a>`CONTAINER_SCANNING` | Container Scanning scanner. |
+| <a id="securityscannertypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | Coverage Fuzzing scanner. |
+| <a id="securityscannertypedast"></a>`DAST` | DAST scanner. |
+| <a id="securityscannertypedependency_scanning"></a>`DEPENDENCY_SCANNING` | Dependency Scanning scanner. |
+| <a id="securityscannertypesast"></a>`SAST` | SAST scanner. |
+| <a id="securityscannertypesecret_detection"></a>`SECRET_DETECTION` | Secret Detection scanner. |
 
 ### `SentryErrorStatus`
 
@@ -16261,8 +16261,8 @@ State of a test report.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="testreportstatefailed"></a>`FAILED` |  |
-| <a id="testreportstatepassed"></a>`PASSED` |  |
+| <a id="testreportstatefailed"></a>`FAILED` | Failed test report. |
+| <a id="testreportstatepassed"></a>`PASSED` | Passed test report. |
 
 ### `TodoActionEnum`
 
@@ -16375,13 +16375,13 @@ Confidence that a given vulnerability is present in the codebase.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilityconfidenceconfirmed"></a>`CONFIRMED` |  |
-| <a id="vulnerabilityconfidenceexperimental"></a>`EXPERIMENTAL` |  |
-| <a id="vulnerabilityconfidencehigh"></a>`HIGH` |  |
-| <a id="vulnerabilityconfidenceignore"></a>`IGNORE` |  |
-| <a id="vulnerabilityconfidencelow"></a>`LOW` |  |
-| <a id="vulnerabilityconfidencemedium"></a>`MEDIUM` |  |
-| <a id="vulnerabilityconfidenceunknown"></a>`UNKNOWN` |  |
+| <a id="vulnerabilityconfidenceconfirmed"></a>`CONFIRMED` | Confirmed confidence. |
+| <a id="vulnerabilityconfidenceexperimental"></a>`EXPERIMENTAL` | Experimental confidence. |
+| <a id="vulnerabilityconfidencehigh"></a>`HIGH` | High confidence. |
+| <a id="vulnerabilityconfidenceignore"></a>`IGNORE` | Ignore confidence. |
+| <a id="vulnerabilityconfidencelow"></a>`LOW` | Low confidence. |
+| <a id="vulnerabilityconfidencemedium"></a>`MEDIUM` | Medium confidence. |
+| <a id="vulnerabilityconfidenceunknown"></a>`UNKNOWN` | Unknown confidence. |
 
 ### `VulnerabilityDismissalReason`
 
@@ -16417,11 +16417,11 @@ The grade of the vulnerable project.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilitygradea"></a>`A` |  |
-| <a id="vulnerabilitygradeb"></a>`B` |  |
-| <a id="vulnerabilitygradec"></a>`C` |  |
-| <a id="vulnerabilitygraded"></a>`D` |  |
-| <a id="vulnerabilitygradef"></a>`F` |  |
+| <a id="vulnerabilitygradea"></a>`A` | A grade. |
+| <a id="vulnerabilitygradeb"></a>`B` | B grade. |
+| <a id="vulnerabilitygradec"></a>`C` | C grade. |
+| <a id="vulnerabilitygraded"></a>`D` | D grade. |
+| <a id="vulnerabilitygradef"></a>`F` | F grade. |
 
 ### `VulnerabilityIssueLinkType`
 
@@ -16429,8 +16429,8 @@ The type of the issue link related to a vulnerability.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilityissuelinktypecreated"></a>`CREATED` |  |
-| <a id="vulnerabilityissuelinktyperelated"></a>`RELATED` |  |
+| <a id="vulnerabilityissuelinktypecreated"></a>`CREATED` | Issue is created for the vulnerability. |
+| <a id="vulnerabilityissuelinktyperelated"></a>`RELATED` | Has a related issue. |
 
 ### `VulnerabilityReportType`
 
@@ -16438,15 +16438,15 @@ The type of the security scan that found the vulnerability.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilityreporttypeapi_fuzzing"></a>`API_FUZZING` |  |
-| <a id="vulnerabilityreporttypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` |  |
-| <a id="vulnerabilityreporttypecontainer_scanning"></a>`CONTAINER_SCANNING` |  |
-| <a id="vulnerabilityreporttypecoverage_fuzzing"></a>`COVERAGE_FUZZING` |  |
-| <a id="vulnerabilityreporttypedast"></a>`DAST` |  |
-| <a id="vulnerabilityreporttypedependency_scanning"></a>`DEPENDENCY_SCANNING` |  |
-| <a id="vulnerabilityreporttypegeneric"></a>`GENERIC` |  |
-| <a id="vulnerabilityreporttypesast"></a>`SAST` |  |
-| <a id="vulnerabilityreporttypesecret_detection"></a>`SECRET_DETECTION` |  |
+| <a id="vulnerabilityreporttypeapi_fuzzing"></a>`API_FUZZING` | API Fuzzing report. |
+| <a id="vulnerabilityreporttypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | Cluster Image Scanning report. |
+| <a id="vulnerabilityreporttypecontainer_scanning"></a>`CONTAINER_SCANNING` | Container Scanning report. |
+| <a id="vulnerabilityreporttypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | Coverage Fuzzing report. |
+| <a id="vulnerabilityreporttypedast"></a>`DAST` | DAST report. |
+| <a id="vulnerabilityreporttypedependency_scanning"></a>`DEPENDENCY_SCANNING` | Dependency Scanning report. |
+| <a id="vulnerabilityreporttypegeneric"></a>`GENERIC` | Generic report. |
+| <a id="vulnerabilityreporttypesast"></a>`SAST` | SAST report. |
+| <a id="vulnerabilityreporttypesecret_detection"></a>`SECRET_DETECTION` | Secret Detection report. |
 
 ### `VulnerabilitySeverity`
 
@@ -16454,12 +16454,12 @@ The severity of the vulnerability.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilityseveritycritical"></a>`CRITICAL` |  |
-| <a id="vulnerabilityseverityhigh"></a>`HIGH` |  |
-| <a id="vulnerabilityseverityinfo"></a>`INFO` |  |
-| <a id="vulnerabilityseveritylow"></a>`LOW` |  |
-| <a id="vulnerabilityseveritymedium"></a>`MEDIUM` |  |
-| <a id="vulnerabilityseverityunknown"></a>`UNKNOWN` |  |
+| <a id="vulnerabilityseveritycritical"></a>`CRITICAL` | Critical severity. |
+| <a id="vulnerabilityseverityhigh"></a>`HIGH` | High severity. |
+| <a id="vulnerabilityseverityinfo"></a>`INFO` | Info severity. |
+| <a id="vulnerabilityseveritylow"></a>`LOW` | Low severity. |
+| <a id="vulnerabilityseveritymedium"></a>`MEDIUM` | Medium severity. |
+| <a id="vulnerabilityseverityunknown"></a>`UNKNOWN` | Unknown severity. |
 
 ### `VulnerabilitySort`
 
@@ -16484,10 +16484,10 @@ The state of the vulnerability.
 
 | Value | Description |
 | ----- | ----------- |
-| <a id="vulnerabilitystateconfirmed"></a>`CONFIRMED` |  |
-| <a id="vulnerabilitystatedetected"></a>`DETECTED` |  |
-| <a id="vulnerabilitystatedismissed"></a>`DISMISSED` |  |
-| <a id="vulnerabilitystateresolved"></a>`RESOLVED` |  |
+| <a id="vulnerabilitystateconfirmed"></a>`CONFIRMED` | Confirmed vulnerability. |
+| <a id="vulnerabilitystatedetected"></a>`DETECTED` | Detected vulnerability. |
+| <a id="vulnerabilitystatedismissed"></a>`DISMISSED` | Dismissed vulnerability. |
+| <a id="vulnerabilitystateresolved"></a>`RESOLVED` | Resolved vulnerability. |
 
 ### `WeightWildcardId`
 

ee/app/graphql/types/iteration_state_enum.rb

@@ -5,14 +5,14 @@ module Types
     graphql_name 'IterationState'
     description 'State of a GitLab iteration'
 
-    value 'upcoming'
-    value 'started', deprecated: {
+    value 'upcoming', description: 'Upcoming iteration.'
+    value 'started', description: 'Started iteration.', deprecated: {
       reason: "Use current instead",
       milestone: '14.1'
     }
-    value 'current'
-    value 'opened'
-    value 'closed'
-    value 'all'
+    value 'current', description: 'Current iteration.'
+    value 'opened', description: 'Open iteration.'
+    value 'closed', description: 'Closed iteration.'
+    value 'all', description: 'Any iteration.'
   end
 end

ee/app/graphql/types/requirements_management/requirement_state_enum.rb

@@ -6,8 +6,8 @@ module Types
       graphql_name 'RequirementState'
       description 'State of a requirement'
 
-      value 'OPENED', value: 'opened'
-      value 'ARCHIVED', value: 'archived'
+      value 'OPENED', value: 'opened', description: 'Open requirement.'
+      value 'ARCHIVED', value: 'archived', description: 'Archived requirement.'
     end
   end
 end

ee/app/graphql/types/requirements_management/test_report_state_enum.rb

@@ -6,8 +6,8 @@ module Types
       graphql_name 'TestReportState'
       description 'State of a test report'
 
-      value 'PASSED', value: 'passed'
-      value 'FAILED', value: 'failed'
+      value 'PASSED', value: 'passed', description: 'Passed test report.'
+      value 'FAILED', value: 'failed', description: 'Failed test report.'
     end
   end
 end

ee/app/graphql/types/security_scanner_type_enum.rb

@@ -6,7 +6,14 @@ module Types
     description 'The type of the security scanner'
 
     ::Security::SecurityJobsFinder.allowed_job_types.each do |scanner|
-      value scanner.upcase.to_s
+      upcase_type = scanner.upcase.to_s
+      human_type = case scanner
+                   when :dast, :sast then upcase_type
+                   when :api_fuzzing then 'API Fuzzing'
+                   else scanner.to_s.titleize
+                   end
+
+      value upcase_type, description: "#{human_type} scanner"
     end
   end
 end

ee/app/graphql/types/vulnerability/issue_link_type_enum.rb

@@ -7,7 +7,14 @@ module Types
       description 'The type of the issue link related to a vulnerability'
 
       ::Vulnerabilities::IssueLink.link_types.keys.each do |link_type|
-        value link_type.to_s.upcase, value: link_type.to_s
+        description = case link_type.to_sym
+                      when :created then 'Issue is created for the vulnerability'
+                      when :related then 'Has a related issue'
+                      else
+                        link_type.to_s.titleize
+                      end
+
+        value link_type.to_s.upcase, value: link_type.to_s, description: description
       end
     end
   end

ee/app/graphql/types/vulnerability_confidence_enum.rb

@@ -6,7 +6,7 @@ module Types
     description 'Confidence that a given vulnerability is present in the codebase.'
 
     ::Enums::Vulnerability.confidence_levels.keys.each do |confidence_level|
-      value confidence_level.to_s.upcase, value: confidence_level.to_s
+      value confidence_level.to_s.upcase, value: confidence_level.to_s, description: "#{confidence_level.to_s.titleize} confidence"
     end
   end
 end

ee/app/graphql/types/vulnerability_grade_enum.rb

@@ -6,7 +6,7 @@ module Types
     description 'The grade of the vulnerable project'
 
     ::Vulnerabilities::Statistic.letter_grades.keys.each do |grade|
-      value grade.to_s.upcase, value: grade.to_s
+      value grade.to_s.upcase, value: grade.to_s, description: "#{grade.to_s.titleize} grade"
     end
   end
 end

ee/app/graphql/types/vulnerability_report_type_enum.rb

@@ -6,7 +6,14 @@ module Types
     description 'The type of the security scan that found the vulnerability'
 
     ::Enums::Vulnerability.report_types.keys.each do |report_type|
-      value report_type.to_s.upcase, value: report_type.to_s
+      upcase_type = report_type.to_s.upcase
+      human_type = case report_type.to_sym
+                   when :dast, :sast then upcase_type
+                   when :api_fuzzing then 'API Fuzzing'
+                   else report_type.to_s.titleize
+                   end
+
+      value upcase_type, value: report_type.to_s, description: "#{human_type} report"
     end
   end
 end

ee/app/graphql/types/vulnerability_severity_enum.rb

@@ -6,7 +6,7 @@ module Types
     description 'The severity of the vulnerability'
 
     ::Enums::Vulnerability.severity_levels.keys.each do |severity|
-      value severity.to_s.upcase, value: severity.to_s
+      value severity.to_s.upcase, value: severity.to_s, description: "#{severity.to_s.titleize} severity"
     end
   end
 end

ee/app/graphql/types/vulnerability_state_enum.rb

@@ -6,7 +6,7 @@ module Types
     description 'The state of the vulnerability'
 
     ::Vulnerability.states.keys.each do |state|
-      value state.to_s.upcase, value: state.to_s
+      value state.to_s.upcase, value: state.to_s, description: "#{state.to_s.titleize} vulnerability"
     end
   end
 end