Fix Rubocop Graphql/Description offenses

https://gitlab.com/gitlab-org/gitlab/-/issues/337596

.rubocop_manual_todo.yml

@@ -22,35 +22,6 @@ Graphql/Descriptions:
     - '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'
-    - 'app/graphql/mutations/admin/sidekiq_queues/delete_jobs.rb'
-    - 'app/graphql/mutations/alert_management/alerts/set_assignees.rb'
-    - 'app/graphql/mutations/alert_management/base.rb'
-    - 'app/graphql/mutations/alert_management/http_integration/create.rb'
-    - 'app/graphql/mutations/alert_management/http_integration/destroy.rb'
-    - 'app/graphql/mutations/alert_management/http_integration/http_integration_base.rb'
-    - 'app/graphql/mutations/alert_management/http_integration/reset_token.rb'
-    - 'app/graphql/mutations/alert_management/http_integration/update.rb'
-    - 'app/graphql/mutations/alert_management/prometheus_integration/create.rb'
-    - 'app/graphql/mutations/alert_management/prometheus_integration/prometheus_integration_base.rb'
-    - 'app/graphql/mutations/alert_management/prometheus_integration/reset_token.rb'
-    - 'app/graphql/mutations/alert_management/prometheus_integration/update.rb'
-    - 'app/graphql/mutations/alert_management/update_alert_status.rb'
-    - 'app/graphql/mutations/award_emojis/base.rb'
-    - 'app/graphql/mutations/boards/common_mutation_arguments.rb'
-    - 'app/graphql/mutations/boards/create.rb'
-    - 'app/graphql/mutations/boards/destroy.rb'
-    - 'app/graphql/mutations/boards/lists/destroy.rb'
-    - 'app/graphql/mutations/boards/update.rb'
-    - 'app/graphql/mutations/ci/ci_cd_settings_update.rb'
-    - 'app/graphql/mutations/ci/job/base.rb'
-    - 'app/graphql/mutations/ci/job/play.rb'
-    - 'app/graphql/mutations/ci/job/retry.rb'
-    - 'app/graphql/mutations/ci/job_token_scope/add_project.rb'
-    - 'app/graphql/mutations/ci/job_token_scope/remove_project.rb'
-    - 'app/graphql/mutations/ci/pipeline/base.rb'
-    - 'app/graphql/mutations/ci/pipeline/retry.rb'
-    - 'app/graphql/mutations/ci/runner/update.rb'
-    - 'app/graphql/mutations/ci/runners_registration_token/reset.rb'
     - 'app/graphql/mutations/commits/create.rb'
     - 'app/graphql/mutations/concerns/mutations/assignable.rb'
     - 'app/graphql/mutations/concerns/mutations/can_mutate_spammable.rb'

app/graphql/mutations/admin/sidekiq_queues/delete_jobs.rb

@@ -18,7 +18,7 @@ module Mutations
         argument :queue_name,
                  GraphQL::Types::String,
                  required: true,
-                 description: 'The name of the queue to delete jobs from.'
+                 description: 'Name of the queue to delete jobs from.'
 
         field :result,
               Types::Admin::SidekiqQueues::DeleteJobsResponseType,

app/graphql/mutations/alert_management/alerts/set_assignees.rb

@@ -9,12 +9,12 @@ module Mutations
         argument :assignee_usernames,
                  [GraphQL::Types::String],
                  required: true,
-                 description: 'The usernames to assign to the alert. Replaces existing assignees by default.'
+                 description: 'Usernames to assign to the alert. Replaces existing assignees by default.'
 
         argument :operation_mode,
                  Types::MutationOperationModeEnum,
                  required: false,
-                 description: 'The operation to perform. Defaults to REPLACE.'
+                 description: 'Operation to perform. Defaults to REPLACE.'
 
         def resolve(args)
           alert = authorized_find!(project_path: args[:project_path], iid: args[:iid])

app/graphql/mutations/alert_management/base.rb

@@ -7,26 +7,26 @@ module Mutations
 
       argument :project_path, GraphQL::Types::ID,
                required: true,
-               description: "The project the alert to mutate is in."
+               description: "Project the alert to mutate is in."
 
       argument :iid, GraphQL::Types::String,
                required: true,
-               description: "The IID of the alert to mutate."
+               description: "IID of the alert to mutate."
 
       field :alert,
             Types::AlertManagement::AlertType,
             null: true,
-            description: "The alert after mutation."
+            description: "Alert after mutation."
 
       field :todo,
             Types::TodoType,
             null: true,
-            description: "The to-do item after mutation."
+            description: "To-do item after mutation."
 
       field :issue,
             Types::IssueType,
             null: true,
-            description: "The issue created after mutation."
+            description: "Issue created after mutation."
 
       authorize :update_alert_management_alert
 

app/graphql/mutations/alert_management/http_integration/create.rb

@@ -10,11 +10,11 @@ module Mutations
 
         argument :project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project to create the integration in.'
+                 description: 'Project to create the integration in.'
 
         argument :name, GraphQL::Types::String,
                  required: true,
-                 description: 'The name of the integration.'
+                 description: 'Name of the integration.'
 
         argument :active, GraphQL::Types::Boolean,
                  required: true,

app/graphql/mutations/alert_management/http_integration/destroy.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, Types::GlobalIDType[::AlertManagement::HttpIntegration],
                  required: true,
-                 description: "The ID of the integration to remove."
+                 description: "ID of the integration to remove."
 
         def resolve(id:)
           integration = authorized_find!(id: id)

app/graphql/mutations/alert_management/http_integration/http_integration_base.rb

@@ -7,7 +7,7 @@ module Mutations
         field :integration,
               Types::AlertManagement::HttpIntegrationType,
               null: true,
-              description: "The HTTP integration."
+              description: "HTTP integration."
 
         authorize :admin_operations
 

app/graphql/mutations/alert_management/http_integration/reset_token.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, Types::GlobalIDType[::AlertManagement::HttpIntegration],
                  required: true,
-                 description: "The ID of the integration to mutate."
+                 description: "ID of the integration to mutate."
 
         def resolve(id:)
           integration = authorized_find!(id: id)

app/graphql/mutations/alert_management/http_integration/update.rb

@@ -8,11 +8,11 @@ module Mutations
 
         argument :id, Types::GlobalIDType[::AlertManagement::HttpIntegration],
                  required: true,
-                 description: "The ID of the integration to mutate."
+                 description: "ID of the integration to mutate."
 
         argument :name, GraphQL::Types::String,
                  required: false,
-                 description: "The name of the integration."
+                 description: "Name of the integration."
 
         argument :active, GraphQL::Types::Boolean,
                  required: false,

app/graphql/mutations/alert_management/prometheus_integration/create.rb

@@ -10,7 +10,7 @@ module Mutations
 
         argument :project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project to create the integration in.'
+                 description: 'Project to create the integration in.'
 
         argument :active, GraphQL::Types::Boolean,
                  required: true,

app/graphql/mutations/alert_management/prometheus_integration/prometheus_integration_base.rb

@@ -7,7 +7,7 @@ module Mutations
         field :integration,
               Types::AlertManagement::PrometheusIntegrationType,
               null: true,
-              description: "The newly created integration."
+              description: "Newly created integration."
 
         authorize :admin_project
 

app/graphql/mutations/alert_management/prometheus_integration/reset_token.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, Types::GlobalIDType[::Integrations::Prometheus],
                  required: true,
-                 description: "The ID of the integration to mutate."
+                 description: "ID of the integration to mutate."
 
         def resolve(id:)
           integration = authorized_find!(id: id)

app/graphql/mutations/alert_management/prometheus_integration/update.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, Types::GlobalIDType[::Integrations::Prometheus],
                  required: true,
-                 description: "The ID of the integration to mutate."
+                 description: "ID of the integration to mutate."
 
         argument :active, GraphQL::Types::Boolean,
                  required: false,

app/graphql/mutations/alert_management/update_alert_status.rb

@@ -7,7 +7,7 @@ module Mutations
 
       argument :status, Types::AlertManagement::StatusEnum,
                required: true,
-               description: 'The status to set the alert.'
+               description: 'Status to set the alert.'
 
       def resolve(project_path:, iid:, status:)
         alert = authorized_find!(project_path: project_path, iid: iid)

app/graphql/mutations/award_emojis/base.rb

@@ -12,7 +12,7 @@ module Mutations
       argument :awardable_id,
                ::Types::GlobalIDType[::Awardable],
                required: true,
-               description: 'The global ID of the awardable resource.'
+               description: 'Global ID of the awardable resource.'
 
       argument :name,
                GraphQL::Types::String,
@@ -22,7 +22,7 @@ module Mutations
       field :award_emoji,
             Types::AwardEmojis::AwardEmojiType,
             null: true,
-            description: 'The award emoji after mutation.'
+            description: 'Award emoji after mutation.'
 
       private
 

app/graphql/mutations/boards/common_mutation_arguments.rb

@@ -9,7 +9,7 @@ module Mutations
         argument :name,
                  GraphQL::Types::String,
                  required: false,
-                 description: 'The board name.'
+                 description: 'Board name.'
         argument :hide_backlog_list,
                  GraphQL::Types::Boolean,
                  required: false,

app/graphql/mutations/boards/create.rb

@@ -12,7 +12,7 @@ module Mutations
       field :board,
             Types::BoardType,
             null: true,
-            description: 'The board after mutation.'
+            description: 'Board after mutation.'
 
       authorize :admin_issue_board
 

app/graphql/mutations/boards/destroy.rb

@@ -8,11 +8,11 @@ module Mutations
       field :board,
             Types::BoardType,
             null: true,
-            description: 'The board after mutation.'
+            description: 'Board after mutation.'
       argument :id,
                 ::Types::GlobalIDType[::Board],
                 required: true,
-                description: 'The global ID of the board to destroy.'
+                description: 'Global ID of the board to destroy.'
 
       authorize :admin_issue_board
 

app/graphql/mutations/boards/lists/destroy.rb

@@ -9,7 +9,7 @@ module Mutations
         field :list,
             Types::BoardListType,
             null: true,
-            description: 'The list after mutation.'
+            description: 'List after mutation.'
 
         argument :list_id, ::Types::GlobalIDType[::List],
                   required: true,

app/graphql/mutations/boards/update.rb

@@ -10,12 +10,12 @@ module Mutations
       argument :id,
                ::Types::GlobalIDType[::Board],
                required: true,
-               description: 'The board global ID.'
+               description: 'Board global ID.'
 
       field :board,
             Types::BoardType,
             null: true,
-            description: 'The board after mutation.'
+            description: 'Board after mutation.'
 
       authorize :admin_issue_board
 

app/graphql/mutations/ci/ci_cd_settings_update.rb

@@ -24,7 +24,7 @@ module Mutations
       field :ci_cd_settings,
         Types::Ci::CiCdSettingType,
         null: false,
-        description: 'The CI/CD settings after mutation.'
+        description: 'CI/CD settings after mutation.'
 
       def resolve(full_path:, **args)
         project = authorized_find!(full_path)

app/graphql/mutations/ci/job/base.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, JobID,
                  required: true,
-                 description: 'The ID of the job to mutate.'
+                 description: 'ID of the job to mutate.'
 
         def find_object(id: )
           # TODO: remove this line when the compatibility layer is removed

app/graphql/mutations/ci/job/play.rb

@@ -9,7 +9,7 @@ module Mutations
         field :job,
               Types::Ci::JobType,
               null: true,
-              description: 'The job after the mutation.'
+              description: 'Job after the mutation.'
 
         authorize :update_build
 

app/graphql/mutations/ci/job/retry.rb

@@ -9,7 +9,7 @@ module Mutations
         field :job,
               Types::Ci::JobType,
               null: true,
-              description: 'The job after the mutation.'
+              description: 'Job after the mutation.'
 
         authorize :update_build
 

app/graphql/mutations/ci/job_token_scope/add_project.rb

@@ -12,16 +12,16 @@ module Mutations
 
         argument :project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project that the CI job token scope belongs to.'
+                 description: 'Project that the CI job token scope belongs to.'
 
         argument :target_project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project to be added to the CI job token scope.'
+                 description: 'Project to be added to the CI job token scope.'
 
         field :ci_job_token_scope,
           Types::Ci::JobTokenScopeType,
           null: true,
-          description: "The CI job token's scope of access."
+          description: "CI job token's scope of access."
 
         def resolve(project_path:, target_project_path:)
           project = authorized_find!(project_path)

app/graphql/mutations/ci/job_token_scope/remove_project.rb

@@ -12,16 +12,16 @@ module Mutations
 
         argument :project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project that the CI job token scope belongs to.'
+                 description: 'Project that the CI job token scope belongs to.'
 
         argument :target_project_path, GraphQL::Types::ID,
                  required: true,
-                 description: 'The project to be removed from the CI job token scope.'
+                 description: 'Project to be removed from the CI job token scope.'
 
         field :ci_job_token_scope,
           Types::Ci::JobTokenScopeType,
           null: true,
-          description: "The CI job token's scope of access."
+          description: "CI job token's scope of access."
 
         def resolve(project_path:, target_project_path:)
           project = authorized_find!(project_path)

app/graphql/mutations/ci/pipeline/base.rb

@@ -8,7 +8,7 @@ module Mutations
 
         argument :id, PipelineID,
                   required: true,
-                  description: 'The ID of the pipeline to mutate.'
+                  description: 'ID of the pipeline to mutate.'
 
         private
 

app/graphql/mutations/ci/pipeline/retry.rb

@@ -9,7 +9,7 @@ module Mutations
         field :pipeline,
               Types::Ci::PipelineType,
               null: true,
-              description: 'The pipeline after mutation.'
+              description: 'Pipeline after mutation.'
 
         authorize :update_pipeline
 

app/graphql/mutations/ci/runner/update.rb

@@ -43,7 +43,7 @@ module Mutations
         field :runner,
               Types::Ci::RunnerType,
               null: true,
-              description: 'The runner after mutation.'
+              description: 'Runner after mutation.'
 
         def resolve(id:, **runner_attrs)
           runner = authorized_find!(id)

app/graphql/mutations/ci/runners_registration_token/reset.rb

@@ -21,7 +21,7 @@ module Mutations
         field :token,
           GraphQL::Types::String,
           null: true,
-          description: 'The runner token after mutation.'
+          description: 'Runner token after mutation.'
 
         def resolve(**args)
           {