Commit 8a9db249 authored by Luke Duncalfe's avatar Luke Duncalfe Committed by Kerri Miller

Fix Rubocop Graphql/Description offenses

parent d16f720d
......@@ -23,31 +23,6 @@ Graphql/Descriptions:
- 'ee/app/graphql/types/vulnerability_severity_enum.rb'
- 'ee/app/graphql/types/vulnerability_state_enum.rb'
- 'ee/app/graphql/types/vulnerability_confidence_enum.rb'
- 'app/graphql/types/repository/blob_type.rb'
- 'app/graphql/types/root_storage_statistics_type.rb'
- 'app/graphql/types/snippet_type.rb'
- 'app/graphql/types/snippets/blob_type.rb'
- 'app/graphql/types/snippets/visibility_scopes_enum.rb'
- 'app/graphql/types/terraform/state_type.rb'
- 'app/graphql/types/terraform/state_version_type.rb'
- 'app/graphql/types/timelog_type.rb'
- 'app/graphql/types/todo_state_enum.rb'
- 'app/graphql/types/todo_target_enum.rb'
- 'app/graphql/types/todo_type.rb'
- 'app/graphql/types/user_interface.rb'
- 'app/graphql/types/user_merge_request_interaction_type.rb'
- 'app/graphql/types/user_state_enum.rb'
- 'ee/app/graphql/ee/mutations/alert_management/http_integration/create.rb'
- 'ee/app/graphql/ee/mutations/alert_management/http_integration/update.rb'
- 'ee/app/graphql/ee/mutations/boards/issues/issue_move_list.rb'
- 'ee/app/graphql/ee/mutations/issues/create.rb'
- 'ee/app/graphql/ee/mutations/issues/update.rb'
- 'ee/app/graphql/ee/types/alert_management/http_integration_type.rb'
- 'ee/app/graphql/ee/types/board_list_type.rb'
- 'ee/app/graphql/ee/types/board_type.rb'
- 'ee/app/graphql/ee/types/group_type.rb'
- 'ee/app/graphql/ee/types/project_type.rb'
- 'ee/app/graphql/ee/types/query_type.rb'
- 'ee/app/graphql/mutations/app_sec/fuzzing/api/ci_configuration/create.rb'
- 'ee/app/graphql/mutations/boards/epic_boards/create.rb'
- 'ee/app/graphql/mutations/boards/epic_boards/epic_move_list.rb'
......
......@@ -48,10 +48,10 @@ module Types
description: 'Size (in bytes) of the blob, or the blob target if stored externally.'
field :raw_blob, GraphQL::Types::String, null: true, method: :data,
description: 'The raw content of the blob.'
description: 'Raw content of the blob.'
field :raw_text_blob, GraphQL::Types::String, null: true, method: :text_only_data,
description: 'The raw content of the blob, if the blob is text data.'
description: 'Raw content of the blob, if the blob is text data.'
field :stored_externally, GraphQL::Types::Boolean, null: true, method: :stored_externally?,
description: "Whether the blob's content is stored externally (for instance, in LFS)."
......@@ -69,7 +69,7 @@ module Types
description: 'Web path to replace the blob content.'
field :file_type, GraphQL::Types::String, null: true,
description: 'The expected format of the blob based on the extension.'
description: 'Expected format of the blob based on the extension.'
field :simple_viewer, type: Types::BlobViewerType,
description: 'Blob content simple viewer.',
......
......@@ -6,14 +6,14 @@ module Types
authorize :read_statistics
field :storage_size, GraphQL::FLOAT_TYPE, null: false, description: 'The total storage in bytes.'
field :repository_size, GraphQL::FLOAT_TYPE, null: false, description: 'The Git repository size in bytes.'
field :lfs_objects_size, GraphQL::FLOAT_TYPE, null: false, description: 'The LFS objects size in bytes.'
field :build_artifacts_size, GraphQL::FLOAT_TYPE, null: false, description: 'The CI artifacts size in bytes.'
field :packages_size, GraphQL::FLOAT_TYPE, null: false, description: 'The packages size in bytes.'
field :wiki_size, GraphQL::FLOAT_TYPE, null: false, description: 'The wiki size in bytes.'
field :snippets_size, GraphQL::FLOAT_TYPE, null: false, description: 'The snippets size in bytes.'
field :pipeline_artifacts_size, GraphQL::FLOAT_TYPE, null: false, description: 'The CI pipeline artifacts size in bytes.'
field :uploads_size, GraphQL::FLOAT_TYPE, null: false, description: 'The uploads size in bytes.'
field :storage_size, GraphQL::FLOAT_TYPE, null: false, description: 'Total storage in bytes.'
field :repository_size, GraphQL::FLOAT_TYPE, null: false, description: 'Git repository size in bytes.'
field :lfs_objects_size, GraphQL::FLOAT_TYPE, null: false, description: 'LFS objects size in bytes.'
field :build_artifacts_size, GraphQL::FLOAT_TYPE, null: false, description: 'CI artifacts size in bytes.'
field :packages_size, GraphQL::FLOAT_TYPE, null: false, description: 'Packages size in bytes.'
field :wiki_size, GraphQL::FLOAT_TYPE, null: false, description: 'Wiki size in bytes.'
field :snippets_size, GraphQL::FLOAT_TYPE, null: false, description: 'Snippets size in bytes.'
field :pipeline_artifacts_size, GraphQL::FLOAT_TYPE, null: false, description: 'CI pipeline artifacts size in bytes.'
field :uploads_size, GraphQL::FLOAT_TYPE, null: false, description: 'Uploads size in bytes.'
end
end
......@@ -22,7 +22,7 @@ module Types
null: false
field :project, Types::ProjectType,
description: 'The project the snippet is associated with.',
description: 'Project the snippet is associated with.',
null: true,
authorize: :read_project
......@@ -30,7 +30,7 @@ module Types
# when the admin setting restricted visibility
# level is set to public
field :author, Types::UserType,
description: 'The owner of the snippet.',
description: 'Owner of the snippet.',
null: true
field :file_name, GraphQL::Types::String,
......
......@@ -17,7 +17,7 @@ module Types
null: true
field :raw_plain_data, GraphQL::Types::String,
description: 'The raw content of the blob, if the blob is text data.',
description: 'Raw content of the blob, if the blob is text data.',
null: true
field :raw_path, GraphQL::Types::String,
......
......@@ -3,9 +3,9 @@
module Types
module Snippets
class VisibilityScopesEnum < BaseEnum
value 'private', description: 'The snippet is visible only to the snippet creator.', value: 'are_private'
value 'internal', description: 'The snippet is visible for any logged in user except external users.', value: 'are_internal'
value 'public', description: 'The snippet can be accessed without any authentication.', value: 'are_public'
value 'private', description: 'Snippet is visible only to the snippet creator.', value: 'are_private'
value 'internal', description: 'Snippet is visible for any logged in user except external users.', value: 'are_internal'
value 'public', description: 'Snippet can be accessed without any authentication.', value: 'are_public'
end
end
end
......@@ -19,7 +19,7 @@ module Types
field :locked_by_user, Types::UserType,
null: true,
description: 'The user currently holding a lock on the Terraform state.'
description: 'User currently holding a lock on the Terraform state.'
field :locked_at, Types::TimeType,
null: true,
......@@ -28,7 +28,7 @@ module Types
field :latest_version, Types::Terraform::StateVersionType,
complexity: 3,
null: true,
description: 'The latest version of the Terraform state.'
description: 'Latest version of the Terraform state.'
field :created_at, Types::TimeType,
null: false,
......
......@@ -15,7 +15,7 @@ module Types
field :created_by_user, Types::UserType,
null: true,
description: 'The user that created this version.'
description: 'User that created this version.'
field :download_path, GraphQL::Types::String,
null: true,
......@@ -23,7 +23,7 @@ module Types
field :job, Types::Ci::JobType,
null: true,
description: 'The job that created this version.'
description: 'Job that created this version.'
field :serial, GraphQL::Types::Int,
null: true,
......
......@@ -14,31 +14,31 @@ module Types
field :time_spent,
GraphQL::Types::Int,
null: false,
description: 'The time spent displayed in seconds.'
description: 'Time spent displayed in seconds.'
field :user,
Types::UserType,
null: false,
description: 'The user that logged the time.'
description: 'User that logged the time.'
field :issue,
Types::IssueType,
null: true,
description: 'The issue that logged time was added to.'
description: 'Issue that logged time was added to.'
field :merge_request,
Types::MergeRequestType,
null: true,
description: 'The merge request that logged time was added to.'
description: 'Merge request that logged time was added to.'
field :note,
Types::Notes::NoteType,
null: true,
description: 'The note where the quick action to add the logged time was executed.'
description: 'Note where the quick action was executed to add the logged time.'
field :summary, GraphQL::Types::String,
null: true,
description: 'The summary of how the time was spent.'
description: 'Summary of how the time was spent.'
def user
Gitlab::Graphql::Loaders::BatchModelLoader.new(User, object.user_id).find
......
......@@ -2,7 +2,7 @@
module Types
class TodoStateEnum < BaseEnum
value 'pending', description: "The state of the todo is pending."
value 'done', description: "The state of the todo is done."
value 'pending', description: "State of the todo is pending."
value 'done', description: "State of the todo is done."
end
end
......@@ -2,11 +2,11 @@
module Types
class TodoTargetEnum < BaseEnum
value 'COMMIT', value: 'Commit', description: 'A Commit.'
value 'ISSUE', value: 'Issue', description: 'An Issue.'
value 'MERGEREQUEST', value: 'MergeRequest', description: 'A MergeRequest.'
value 'DESIGN', value: 'DesignManagement::Design', description: 'A Design.'
value 'ALERT', value: 'AlertManagement::Alert', description: 'An Alert.'
value 'COMMIT', value: 'Commit', description: 'Commit.'
value 'ISSUE', value: 'Issue', description: 'Issue.'
value 'MERGEREQUEST', value: 'MergeRequest', description: 'Merge request.'
value 'DESIGN', value: 'DesignManagement::Design', description: 'Design.'
value 'ALERT', value: 'AlertManagement::Alert', description: 'Alert.'
end
end
......
......@@ -14,7 +14,7 @@ module Types
null: false
field :project, Types::ProjectType,
description: 'The project this to-do item is associated with.',
description: 'Project this to-do item is associated with.',
null: true,
authorize: :read_project
......@@ -24,7 +24,7 @@ module Types
authorize: :read_group
field :author, Types::UserType,
description: 'The author of this to-do item.',
description: 'Author of this to-do item.',
null: false
field :action, Types::TodoActionEnum,
......
......@@ -72,7 +72,7 @@ module Types
field :location,
type: ::GraphQL::Types::String,
null: true,
description: 'The location of the user.'
description: 'Location of the user.'
field :project_memberships,
type: Types::ProjectMemberType.connection_type,
null: true,
......
......@@ -28,7 +28,7 @@ module Types
field :review_state,
::Types::MergeRequestReviewStateEnum,
null: true,
description: 'The state of the review by this user.'
description: 'State of the review by this user.'
field :reviewed,
type: ::GraphQL::Types::Boolean,
......
......@@ -5,8 +5,8 @@ module Types
graphql_name 'UserState'
description 'Possible states of a user'
value 'active', 'The user is active and is able to use the system.', value: 'active'
value 'blocked', 'The user has been blocked and is prevented from using the system.', value: 'blocked'
value 'deactivated', 'The user is no longer active and is unable to use the system.', value: 'deactivated'
value 'active', 'User is active and is able to use the system.', value: 'active'
value 'blocked', 'User has been blocked and is prevented from using the system.', value: 'blocked'
value 'deactivated', 'User is no longer active and is unable to use the system.', value: 'deactivated'
end
end
This diff is collapsed.
......@@ -10,11 +10,11 @@ module EE
prepended do
argument :payload_example, ::Types::JsonStringType,
required: false,
description: 'The example of an alert payload.'
description: 'Example of an alert payload.'
argument :payload_attribute_mappings, [::Types::AlertManagement::PayloadAlertFieldInputType],
required: false,
description: 'The custom mapping of GitLab alert attributes to fields from the payload_example.'
description: 'Custom mapping of GitLab alert attributes to fields from the payload example.'
end
end
end
......
......@@ -10,11 +10,11 @@ module EE
prepended do
argument :payload_example, ::Types::JsonStringType,
required: false,
description: 'The example of an alert payload.'
description: 'Example of an alert payload.'
argument :payload_attribute_mappings, [::Types::AlertManagement::PayloadAlertFieldInputType],
required: false,
description: 'The custom mapping of GitLab alert attributes to fields from the payload_example.'
description: 'Custom mapping of GitLab alert attributes to fields from the payload example.'
end
end
end
......
......@@ -12,7 +12,7 @@ module EE
argument :epic_id, ::Types::GlobalIDType[::Epic],
required: false,
description: 'The ID of an epic to associate the issue with.'
description: 'ID of an epic to associate the issue with.'
end
override :resolve
......
......@@ -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: 'ID of the parent epic. NULL when removing the association.'
end
def resolve(**args)
......
......@@ -9,7 +9,7 @@ module EE
prepended do
field :payload_example, ::Types::JsonStringType,
null: true,
description: 'The example of an alert payload.'
description: 'Example of an alert payload.'
field :payload_attribute_mappings, [::Types::AlertManagement::PayloadAlertMappingFieldType],
null: true,
......
......@@ -17,7 +17,7 @@ module EE
field :assignee, ::Types::UserType, null: true,
description: 'Assignee in the list.'
field :limit_metric, ::EE::Types::ListLimitMetricEnum, null: true,
description: 'The current limit metric for the list.'
description: 'Current limit metric for the list.'
field :total_weight, GraphQL::Types::Int, null: true,
description: 'Total weight of all issues in the list.'
......
......@@ -7,7 +7,7 @@ module EE
prepended do
field :assignee, type: ::Types::UserType, null: true,
description: 'The board assignee.'
description: 'Board assignee.'
field :epics, ::Types::Boards::BoardEpicType.connection_type, null: true,
description: 'Epics associated with board issues.',
......@@ -18,10 +18,10 @@ module EE
description: 'Labels of the board.'
field :milestone, type: ::Types::MilestoneType, null: true,
description: 'The board milestone.'
description: 'Board milestone.'
field :iteration, type: ::Types::IterationType, null: true,
description: 'The board iteration.'
description: 'Board iteration.'
field :weight, type: GraphQL::Types::Int, null: true,
description: 'Weight of the board.'
......
......@@ -85,13 +85,13 @@ module EE
field :billable_members_count, ::GraphQL::Types::Int,
null: true,
description: 'The number of billable users in the group.'
description: 'Number of billable users in the group.'
field :dora,
::Types::DoraType,
null: true,
method: :itself,
description: "The group's DORA metrics."
description: "Group's DORA metrics."
end
end
end
......
......@@ -87,7 +87,7 @@ module EE
field :dast_scanner_profiles,
::Types::DastScannerProfileType.connection_type,
null: true,
description: 'The DAST scanner profiles associated with the project.'
description: 'DAST scanner profiles associated with the project.'
field :dast_site_validations,
::Types::DastSiteValidationType.connection_type,
......@@ -165,7 +165,7 @@ module EE
field :push_rules,
::Types::PushRulesType,
null: true,
description: "The project's push rules settings.",
description: "Project's push rules settings.",
method: :push_rule
field :path_locks,
......@@ -192,7 +192,7 @@ module EE
::Types::DoraType,
null: true,
method: :itself,
description: "The project's DORA metrics."
description: "Project's DORA metrics."
end
def api_fuzzing_ci_configuration
......
......@@ -26,7 +26,7 @@ module EE
description: "Find a vulnerability." do
argument :id, ::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'The Global ID of the Vulnerability.'
description: 'Global ID of the Vulnerability.'
end
field :vulnerabilities_count_by_day,
......@@ -64,7 +64,7 @@ module EE
field :ci_minutes_usage, ::Types::Ci::Minutes::NamespaceMonthlyUsageType.connection_type,
null: true,
description: 'The monthly CI minutes usage data for the current user.'
description: 'Monthly CI minutes usage data for the current user.'
end
def vulnerability(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