Commit 8589324e authored by Dylan Griffith's avatar Dylan Griffith

Merge branch '292426-fix-graphql-descriptions-rubocop-offenses-3' into 'master'

Fix Graphql/Descriptions EE mutation offenses

See merge request gitlab-org/gitlab!51420
parents 643e2eba c64366eb
......@@ -881,10 +881,6 @@ Graphql/Descriptions:
- 'app/graphql/types/tree/tree_type.rb'
- 'app/graphql/types/user_status_type.rb'
- 'app/graphql/types/user_type.rb'
- 'ee/app/graphql/ee/mutations/boards/issues/issue_move_list.rb'
- 'ee/app/graphql/ee/mutations/boards/lists/create.rb'
- 'ee/app/graphql/ee/mutations/issues/create.rb'
- 'ee/app/graphql/ee/mutations/issues/update.rb'
- 'ee/app/graphql/ee/resolvers/issues_resolver.rb'
- 'ee/app/graphql/ee/resolvers/namespace_projects_resolver.rb'
- 'ee/app/graphql/ee/types/board_list_type.rb'
......@@ -898,44 +894,6 @@ Graphql/Descriptions:
- 'ee/app/graphql/ee/types/namespace_type.rb'
- 'ee/app/graphql/ee/types/project_type.rb'
- 'ee/app/graphql/ee/types/query_type.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/delete.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/mixins.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/update.rb'
- 'ee/app/graphql/mutations/boards/lists/update_limit_metrics.rb'
- 'ee/app/graphql/mutations/boards/update.rb'
- 'ee/app/graphql/mutations/boards/update_epic_user_preferences.rb'
- 'ee/app/graphql/mutations/compliance_management/frameworks/destroy.rb'
- 'ee/app/graphql/mutations/compliance_management/frameworks/update.rb'
- 'ee/app/graphql/mutations/clusters/agent_tokens/create.rb'
- 'ee/app/graphql/mutations/clusters/agent_tokens/delete.rb'
- 'ee/app/graphql/mutations/clusters/agents/create.rb'
- 'ee/app/graphql/mutations/clusters/agents/delete.rb'
- 'ee/app/graphql/mutations/concerns/mutations/shared_epic_arguments.rb'
- 'ee/app/graphql/mutations/epic_tree/reorder.rb'
- 'ee/app/graphql/mutations/epics/add_issue.rb'
- 'ee/app/graphql/mutations/epics/base.rb'
- 'ee/app/graphql/mutations/epics/create.rb'
- 'ee/app/graphql/mutations/epics/set_subscription.rb'
- 'ee/app/graphql/mutations/epics/update.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/create.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/destroy.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/oncall_schedule_base.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/update.rb'
- 'ee/app/graphql/mutations/instance_security_dashboard/add_project.rb'
- 'ee/app/graphql/mutations/instance_security_dashboard/remove_project.rb'
- 'ee/app/graphql/mutations/issues/common_ee_mutation_arguments.rb'
- 'ee/app/graphql/mutations/issues/promote_to_epic.rb'
- 'ee/app/graphql/mutations/issues/set_weight.rb'
- 'ee/app/graphql/mutations/iterations/create.rb'
- 'ee/app/graphql/mutations/namespaces/base.rb'
- 'ee/app/graphql/mutations/quality_management/test_cases/create.rb'
- 'ee/app/graphql/mutations/requirements_management/base_requirement.rb'
- 'ee/app/graphql/mutations/requirements_management/update_requirement.rb'
- 'ee/app/graphql/mutations/security/ci_configuration/configure_sast.rb'
- 'ee/app/graphql/mutations/vulnerabilities/confirm.rb'
- 'ee/app/graphql/mutations/vulnerabilities/dismiss.rb'
- 'ee/app/graphql/mutations/vulnerabilities/resolve.rb'
- 'ee/app/graphql/mutations/vulnerabilities/revert_to_detected.rb'
- 'ee/app/graphql/resolvers/board_groupings/epics_resolver.rb'
- 'ee/app/graphql/resolvers/boards/epic_boards_resolver.rb'
- 'ee/app/graphql/resolvers/ci/code_coverage_activities_resolver.rb'
......
This diff is collapsed.
......@@ -13,7 +13,7 @@ module EE
prepended do
argument :epic_id, EpicID,
required: false,
description: 'The ID of the parent epic. NULL when removing the association'
description: 'The ID of the parent epic. NULL when removing the association.'
end
override :move_issue
......
......@@ -11,13 +11,13 @@ module EE
prepended do
argument :milestone_id, ::Types::GlobalIDType[::Milestone],
required: false,
description: 'Global ID of an existing milestone'
description: 'Global ID of an existing milestone.'
argument :iteration_id, ::Types::GlobalIDType[::Iteration],
required: false,
description: 'Global ID of an existing iteration'
description: 'Global ID of an existing iteration.'
argument :assignee_id, ::Types::GlobalIDType[::User],
required: false,
description: 'Global ID of an existing user'
description: 'Global ID of an existing user.'
end
private
......
......@@ -11,7 +11,7 @@ module EE
argument :epic_id, ::Types::GlobalIDType[::Epic],
required: false,
description: 'The ID of an epic to associate the issue with'
description: 'The ID of an epic to associate the issue with.'
end
private
......
......@@ -12,7 +12,7 @@ module EE
argument :epic_id, ::Types::GlobalIDType[::Epic],
required: false,
loads: ::Types::EpicType,
description: 'The ID of the parent epic. NULL when removing the association'
description: 'The ID of the parent epic. NULL when removing the association.'
end
def resolve(**args)
......
......@@ -12,7 +12,7 @@ module Mutations
argument :id, ::Types::GlobalIDType[::Analytics::DevopsAdoption::Segment],
required: true,
description: "ID of the segment"
description: "ID of the segment."
def resolve(id:, **)
response = ::Analytics::DevopsAdoption::Segments::DeleteService
......
......@@ -41,16 +41,16 @@ module Mutations
included do
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'Name of the segment'
description: 'Name of the segment.'
argument :group_ids, [::Types::GlobalIDType[::Group]],
required: false,
description: 'The array of group IDs to set for the segment'
description: 'The array of group IDs to set for the segment.'
field :segment,
Types::Admin::Analytics::DevopsAdoption::SegmentType,
null: true,
description: 'The segment after mutation'
description: 'The segment after mutation.'
end
end
end
......
......@@ -13,7 +13,7 @@ module Mutations
argument :id, ::Types::GlobalIDType[::Analytics::DevopsAdoption::Segment],
required: true,
description: "ID of the segment"
description: "ID of the segment."
def resolve(id:, name:, group_ids: nil, **)
groups = GlobalID::Locator.locate_many(group_ids) if group_ids
......
......@@ -29,7 +29,7 @@ module Mutations
field :list,
::Types::BoardListType,
null: true,
description: 'The updated list'
description: 'The updated list.'
def ready?(**args)
if limit_metric_settings_of(args).blank?
......
......@@ -8,22 +8,22 @@ module Mutations
argument :board_id,
::Types::GlobalIDType[::Board],
required: true,
description: 'The board global ID'
description: 'The board global ID.'
argument :epic_id,
::Types::GlobalIDType[::Epic],
required: true,
description: 'ID of an epic to set preferences for'
description: 'ID of an epic to set preferences for.'
argument :collapsed,
GraphQL::BOOLEAN_TYPE,
required: true,
description: 'Whether the epic should be collapsed in the board'
description: 'Whether the epic should be collapsed in the board.'
field :epic_user_preferences,
Types::Boards::EpicUserPreferencesType,
null: true,
description: 'User preferences for the epic in the board after mutation'
description: 'User preferences for the epic in the board after mutation.'
authorize :read_board
......
......@@ -12,17 +12,17 @@ module Mutations
argument :cluster_agent_id, ClusterAgentID,
required: true,
description: 'Global ID of the cluster agent that will be associated with the new token'
description: 'Global ID of the cluster agent that will be associated with the new token.'
field :secret,
GraphQL::STRING_TYPE,
null: true,
description: "Token secret value. Make sure you save it - you won't be able to access it again"
description: "Token secret value. Make sure you save it - you won't be able to access it again."
field :token,
Types::Clusters::AgentTokenType,
null: true,
description: 'Token created after mutation'
description: 'Token created after mutation.'
def resolve(cluster_agent_id:)
cluster_agent = authorized_find!(id: cluster_agent_id)
......
......@@ -12,7 +12,7 @@ module Mutations
argument :id, TokenID,
required: true,
description: 'Global ID of the cluster agent token that will be deleted'
description: 'Global ID of the cluster agent token that will be deleted.'
def resolve(id:)
token = authorized_find!(id: id)
......
......@@ -12,16 +12,16 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full path of the associated project for this cluster agent'
description: 'Full path of the associated project for this cluster agent.'
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'Name of the cluster agent'
description: 'Name of the cluster agent.'
field :cluster_agent,
Types::Clusters::AgentType,
null: true,
description: 'Cluster agent created after mutation'
description: 'Cluster agent created after mutation.'
def resolve(project_path:, name:)
project = authorized_find!(full_path: project_path)
......
......@@ -12,7 +12,7 @@ module Mutations
argument :id, AgentID,
required: true,
description: 'Global ID of the cluster agent that will be deleted'
description: 'Global ID of the cluster agent that will be deleted.'
def resolve(id:)
cluster_agent = authorized_find!(id: id)
......
......@@ -11,7 +11,7 @@ module Mutations
argument :id,
::Types::GlobalIDType[::ComplianceManagement::Framework],
required: true,
description: 'The global ID of the compliance framework to destroy'
description: 'The global ID of the compliance framework to destroy.'
def resolve(id:)
framework = authorized_find!(id: id)
......
......@@ -7,42 +7,42 @@ module Mutations
prepended do
argument :group_path, GraphQL::ID_TYPE,
required: true,
description: "The group the epic to mutate is in"
description: "The group the epic to mutate is in."
argument :title,
GraphQL::STRING_TYPE,
required: false,
description: 'The title of the epic'
description: 'The title of the epic.'
argument :description,
GraphQL::STRING_TYPE,
required: false,
description: 'The description of the epic'
description: 'The description of the epic.'
argument :confidential,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates if the epic is confidential'
description: 'Indicates if the epic is confidential.'
argument :start_date_fixed,
GraphQL::STRING_TYPE,
required: false,
description: 'The start date of the epic'
description: 'The start date of the epic.'
argument :due_date_fixed,
GraphQL::STRING_TYPE,
required: false,
description: 'The end date of the epic'
description: 'The end date of the epic.'
argument :start_date_is_fixed,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates start date should be sourced from start_date_fixed field not the issue milestones'
description: 'Indicates start date should be sourced from start_date_fixed field not the issue milestones.'
argument :due_date_is_fixed,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates end date should be sourced from due_date_fixed field not the issue milestones'
description: 'Indicates end date should be sourced from due_date_fixed field not the issue milestones.'
argument :add_label_ids,
[GraphQL::ID_TYPE],
required: false,
......
......@@ -10,12 +10,12 @@ module Mutations
argument :base_epic_id,
::Types::GlobalIDType[::Epic],
required: true,
description: 'The ID of the base epic of the tree'
description: 'The ID of the base epic of the tree.'
argument :moved,
Types::EpicTree::EpicTreeNodeInputType,
required: true,
description: 'Parameters for updating the tree positions'
description: 'Parameters for updating the tree positions.'
def resolve(args)
moving_object_id = args[:moved][:id]
......
......@@ -11,16 +11,16 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The full path of the project the issue belongs to'
description: 'The full path of the project the issue belongs to.'
argument :issue_iid, GraphQL::STRING_TYPE,
required: true,
description: 'The IID of the issue to be added'
description: 'The IID of the issue to be added.'
field :epic_issue,
Types::EpicIssueType,
null: true,
description: 'The epic-issue relation'
description: 'The epic-issue relation.'
def resolve(group_path:, iid:, project_path:, issue_iid:)
epic = authorized_find!(group_path: group_path, iid: iid)
......
......@@ -7,16 +7,16 @@ module Mutations
argument :iid, GraphQL::ID_TYPE,
required: true,
description: "The IID of the epic to mutate"
description: "The IID of the epic to mutate."
argument :group_path, GraphQL::ID_TYPE,
required: true,
description: 'The group the epic to mutate belongs to'
description: 'The group the epic to mutate belongs to.'
field :epic,
Types::EpicType,
null: true,
description: 'The epic after mutation'
description: 'The epic after mutation.'
private
......
......@@ -13,7 +13,7 @@ module Mutations
field :epic,
Types::EpicType,
null: true,
description: 'The created epic'
description: 'The created epic.'
def resolve(args)
group_path = args.delete(:group_path)
......
......@@ -9,7 +9,7 @@ module Mutations
argument :subscribed_state, GraphQL::BOOLEAN_TYPE,
required: true,
description: 'The desired state of the subscription'
description: 'The desired state of the subscription.'
def resolve(args)
group_path = args.delete(:group_path)
......
......@@ -10,7 +10,7 @@ module Mutations
argument :state_event,
Types::EpicStateEventEnum,
required: false,
description: 'State event for the epic'
description: 'State event for the epic.'
authorize :admin_epic
......
......@@ -10,19 +10,19 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to create the on-call schedule in'
description: 'The project to create the on-call schedule in.'
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'The name of the on-call schedule'
description: 'The name of the on-call schedule.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The description of the on-call schedule'
description: 'The description of the on-call schedule.'
argument :timezone, GraphQL::STRING_TYPE,
required: true,
description: 'The timezone of the on-call schedule'
description: 'The timezone of the on-call schedule.'
def resolve(args)
project = authorized_find!(full_path: args[:project_path])
......
......@@ -8,11 +8,11 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to remove the on-call schedule from'
description: 'The project to remove the on-call schedule from.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The on-call schedule internal ID to remove'
description: 'The on-call schedule internal ID to remove.'
def resolve(project_path:, iid:)
oncall_schedule = authorized_find!(project_path: project_path, iid: iid)
......
......@@ -7,7 +7,7 @@ module Mutations
field :oncall_schedule,
::Types::IncidentManagement::OncallScheduleType,
null: true,
description: 'The on-call schedule'
description: 'The on-call schedule.'
authorize :admin_incident_management_oncall_schedule
......
......@@ -8,23 +8,23 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to update the on-call schedule in'
description: 'The project to update the on-call schedule in.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The on-call schedule internal ID to update'
description: 'The on-call schedule internal ID to update.'
argument :name, GraphQL::STRING_TYPE,
required: false,
description: 'The name of the on-call schedule'
description: 'The name of the on-call schedule.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The description of the on-call schedule'
description: 'The description of the on-call schedule.'
argument :timezone, GraphQL::STRING_TYPE,
required: false,
description: 'The timezone of the on-call schedule'
description: 'The timezone of the on-call schedule.'
def resolve(args)
oncall_schedule = authorized_find!(project_path: args[:project_path], iid: args[:iid])
......
......@@ -9,11 +9,11 @@ module Mutations
field :project, Types::ProjectType,
null: true,
description: 'Project that was added to the Instance Security Dashboard'
description: 'Project that was added to the Instance Security Dashboard.'
argument :id, ::Types::GlobalIDType[::Project],
required: true,
description: 'ID of the project to be added to Instance Security Dashboard'
description: 'ID of the project to be added to Instance Security Dashboard.'
def resolve(id:)
project = authorized_find!(id: id)
......
......@@ -9,7 +9,7 @@ module Mutations
argument :id, Types::GlobalIDType[::Project],
required: true,
description: 'ID of the project to remove from the Instance Security Dashboard'
description: 'ID of the project to remove from the Instance Security Dashboard.'
def resolve(id:)
dashboard = authorized_find!
......
......@@ -9,11 +9,11 @@ module Mutations
argument :health_status,
::Types::HealthStatusEnum,
required: false,
description: 'The desired health status'
description: 'The desired health status.'
argument :weight, GraphQL::INT_TYPE,
required: false,
description: 'The weight of the issue'
description: 'The weight of the issue.'
end
end
end
......
......@@ -9,12 +9,12 @@ module Mutations
argument :group_path, GraphQL::ID_TYPE,
required: false,
description: 'The group the promoted epic will belong to'
description: 'The group the promoted epic will belong to.'
field :epic,
Types::EpicType,
null: true,
description: "The epic after issue promotion"
description: "The epic after issue promotion."
def resolve(project_path:, iid:, group_path: nil)
errors = []
......
......@@ -8,7 +8,7 @@ module Mutations
argument :weight,
GraphQL::INT_TYPE,
required: true,
description: 'The desired weight for the issue'
description: 'The desired weight for the issue.'
def resolve(project_path:, iid:, weight:)
issue = authorized_find!(project_path: project_path, iid: iid)
......
......@@ -13,35 +13,35 @@ module Mutations
field :iteration,
Types::IterationType,
null: true,
description: 'The created iteration'
description: 'The created iteration.'
argument :group_path, GraphQL::ID_TYPE,
required: false,
description: "The target group for the iteration"
description: "The target group for the iteration."
argument :project_path, GraphQL::ID_TYPE,
required: false,
description: "The target project for the iteration"
description: "The target project for the iteration."
argument :title,
GraphQL::STRING_TYPE,
required: false,
description: 'The title of the iteration'
description: 'The title of the iteration.'
argument :description,
GraphQL::STRING_TYPE,
required: false,
description: 'The description of the iteration'
description: 'The description of the iteration.'
argument :start_date,
GraphQL::STRING_TYPE,
required: false,
description: 'The start date of the iteration'
description: 'The start date of the iteration.'
argument :due_date,
GraphQL::STRING_TYPE,
required: false,
description: 'The end date of the iteration'
description: 'The end date of the iteration.'
def resolve(args)
validate_arguments!(args)
......
......@@ -5,12 +5,12 @@ module Mutations
class Base < ::Mutations::BaseMutation
argument :id, ::Types::GlobalIDType[::Namespace],
required: true,
description: 'The global ID of the namespace to mutate'
description: 'The global ID of the namespace to mutate.'
field :namespace,
Types::NamespaceType,
null: true,
description: 'The namespace after mutation'
description: 'The namespace after mutation.'
private
......
......@@ -12,11 +12,11 @@ module Mutations
argument :title, GraphQL::STRING_TYPE,
required: true,
description: 'The test case title'
description: 'The test case title.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The test case description'
description: 'The test case description.'
argument :label_ids,
[GraphQL::ID_TYPE],
......@@ -25,11 +25,11 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project full path to create the test case'
description: 'The project full path to create the test case.'
field :test_case, Types::IssueType,
null: true,
description: 'The test case created'
description: 'The test case created.'
def resolve(args)
project_path = args.delete(:project_path)
......
......@@ -7,19 +7,19 @@ module Mutations
field :requirement, Types::RequirementsManagement::RequirementType,
null: true,
description: 'Requirement after mutation'
description: 'Requirement after mutation.'
argument :title, GraphQL::STRING_TYPE,
required: false,
description: 'Title of the requirement'
description: 'Title of the requirement.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'Description of the requirement'
description: 'Description of the requirement.'
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full project path the requirement is associated with'
description: 'Full project path the requirement is associated with.'
end
end
end
......@@ -9,15 +9,15 @@ module Mutations
argument :state, Types::RequirementsManagement::RequirementStateEnum,
required: false,
description: 'State of the requirement'
description: 'State of the requirement.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The IID of the requirement to update'
description: 'The IID of the requirement to update.'
argument :last_test_report_state, Types::RequirementsManagement::TestReportStateEnum,
required: false,
description: 'Creates a test report for the requirement with the given state'
description: 'Creates a test report for the requirement with the given state.'
def ready?(**args)
update_args = [:title, :state, :last_test_report_state, :description]
......
......@@ -10,17 +10,17 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full path of the project'
description: 'Full path of the project.'
argument :configuration, ::Types::CiConfiguration::Sast::InputType,
required: true,
description: 'SAST CI configuration for the project'
description: 'SAST CI configuration for the project.'
field :status, GraphQL::STRING_TYPE, null: false,
description: 'Status of creating the commit for the supplied SAST CI configuration'
description: 'Status of creating the commit for the supplied SAST CI configuration.'
field :success_path, GraphQL::STRING_TYPE, null: true,
description: 'Redirect path to use when the response is successful'
description: 'Redirect path to use when the response is successful.'
authorize :push_code
......
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after state change'
description: 'The vulnerability after state change.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be confirmed'
description: 'ID of the vulnerability to be confirmed.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
......@@ -9,22 +9,22 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after dismissal'
description: 'The vulnerability after dismissal.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be dismissed'
description: 'ID of the vulnerability to be dismissed.'
argument :comment,
GraphQL::STRING_TYPE,
required: false,
description: 'Comment why vulnerability should be dismissed'
description: 'Comment why vulnerability should be dismissed.'
argument :dismissal_reason,
Types::Vulnerabilities::DismissalReasonEnum,
required: false,
description: 'Reason why vulnerability should be dismissed'
description: 'Reason why vulnerability should be dismissed.'
def resolve(id:, comment: nil, dismissal_reason: nil)
vulnerability = authorized_find!(id: id)
......
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after state change'
description: 'The vulnerability after state change.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be resolved'
description: 'ID of the vulnerability to be resolved.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after revert'
description: 'The vulnerability after revert.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be reverted'
description: 'ID of the vulnerability to be reverted.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment