Skip to content

G
gitlab-ce
Commit fab4f707 authored by Luke Duncalfe's avatar Luke Duncalfe
Browse files
Options

Fix Graphql/Descriptions FOSS types offenses 

https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46721 introduced a
new rubocop that enforced periods at the end of GraphQL description
strings. Existing offenses were added to `.rubocop_manual_todo.yml`.

This change fixes roughly half of the offenses in `app/graphql/types`
and removes the exclusion of them from `.rubocop_manual_todo.yml`.

The changes were generated using the following autocorrect:

    bundle exec rubocop app/graphql/types \
      --auto-correct \
      --only Graphql/Descriptions

https://gitlab.com/gitlab-org/gitlab/-/issues/292426
parent f1a4ee68
Hide whitespace changes
Inline Side-by-side
Showing with 1478 additions and 1538 deletions
.rubocop_manual_todo.yml
View file @ fab4f707
......@@ -766,66 +766,6 @@ RSpec/TimecopTravel:
Graphql/Descriptions:
Exclude:
- 'app/graphql/types/access_level_type.rb'
- 'app/graphql/types/admin/analytics/instance_statistics/measurement_type.rb'
- 'app/graphql/types/admin/sidekiq_queues/delete_jobs_response_type.rb'
- 'app/graphql/types/alert_management/alert_status_counts_type.rb'
- 'app/graphql/types/alert_management/alert_type.rb'
- 'app/graphql/types/alert_management/integration_type.rb'
- 'app/graphql/types/award_emojis/award_emoji_type.rb'
- 'app/graphql/types/board_list_type.rb'
- 'app/graphql/types/board_type.rb'
- 'app/graphql/types/boards/board_issue_input_base_type.rb'
- 'app/graphql/types/boards/board_issue_input_type.rb'
- 'app/graphql/types/branch_type.rb'
- 'app/graphql/types/ci/analytics_type.rb'
- 'app/graphql/types/ci/config/config_type.rb'
- 'app/graphql/types/ci/config/group_type.rb'
- 'app/graphql/types/ci/config/job_type.rb'
- 'app/graphql/types/ci/config/need_type.rb'
- 'app/graphql/types/ci/config/stage_type.rb'
- 'app/graphql/types/ci/detailed_status_type.rb'
- 'app/graphql/types/ci/group_type.rb'
- 'app/graphql/types/ci/job_artifact_type.rb'
- 'app/graphql/types/ci/job_type.rb'
- 'app/graphql/types/ci/pipeline_type.rb'
- 'app/graphql/types/ci/runner_architecture_type.rb'
- 'app/graphql/types/ci/runner_platform_type.rb'
- 'app/graphql/types/ci/runner_setup_type.rb'
- 'app/graphql/types/ci/stage_type.rb'
- 'app/graphql/types/ci/status_action_type.rb'
- 'app/graphql/types/commit_action_type.rb'
- 'app/graphql/types/commit_type.rb'
- 'app/graphql/types/container_expiration_policy_type.rb'
- 'app/graphql/types/container_repository_details_type.rb'
- 'app/graphql/types/container_repository_type.rb'
- 'app/graphql/types/countable_connection_type.rb'
- 'app/graphql/types/current_user_todos.rb'
- 'app/graphql/types/custom_emoji_type.rb'
- 'app/graphql/types/design_management/design_at_version_type.rb'
- 'app/graphql/types/design_management/design_collection_type.rb'
- 'app/graphql/types/design_management/design_fields.rb'
- 'app/graphql/types/design_management/design_type.rb'
- 'app/graphql/types/design_management/version_type.rb'
- 'app/graphql/types/design_management_type.rb'
- 'app/graphql/types/diff_paths_input_type.rb'
- 'app/graphql/types/diff_refs_type.rb'
- 'app/graphql/types/diff_stats_summary_type.rb'
- 'app/graphql/types/diff_stats_type.rb'
- 'app/graphql/types/environment_type.rb'
- 'app/graphql/types/error_tracking/sentry_detailed_error_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_collection_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_frequency_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_stack_trace_context_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_stack_trace_entry_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_stack_trace_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_tags_type.rb'
- 'app/graphql/types/error_tracking/sentry_error_type.rb'
- 'app/graphql/types/evidence_type.rb'
- 'app/graphql/types/grafana_integration_type.rb'
- 'app/graphql/types/group_invitation_type.rb'
- 'app/graphql/types/group_member_type.rb'
- 'app/graphql/types/group_type.rb'
- 'app/graphql/types/invitation_interface.rb'
- 'app/graphql/types/issue_type.rb'
- 'app/graphql/types/jira_import_type.rb'
......
app/graphql/types/access_level_type.rb
View file @ fab4f707
......@@ -7,11 +7,11 @@ module Types
description 'Represents the access level of a relationship between a User and object that it is related to'
field :integer_value, GraphQL::INT_TYPE, null: true,
description: 'Integer representation of access level',
description: 'Integer representation of access level.',
method: :to_i
field :string_value, Types::AccessLevelEnum, null: true,
description: 'String representation of access level',
description: 'String representation of access level.',
method: :to_i
end
end
app/graphql/types/admin/analytics/instance_statistics/measurement_type.rb
View file @ fab4f707
......@@ -12,13 +12,13 @@ module Types
authorize :read_instance_statistics_measurements
field :recorded_at, Types::TimeType, null: true,
description: 'The time the measurement was recorded'
description: 'The time the measurement was recorded.'
field :count, GraphQL::INT_TYPE, null: false,
description: 'Object count'
description: 'Object count.'
field :identifier, Types::Admin::Analytics::InstanceStatistics::MeasurementIdentifierEnum, null: false,
description: 'The type of objects being measured'
description: 'The type of objects being measured.'
end
end
end
......
app/graphql/types/admin/sidekiq_queues/delete_jobs_response_type.rb
View file @ fab4f707
......@@ -12,17 +12,17 @@ module Types
field :completed,
GraphQL::BOOLEAN_TYPE,
null: true,
description: 'Whether or not the entire queue was processed in time; if not, retrying the same request is safe'
description: 'Whether or not the entire queue was processed in time; if not, retrying the same request is safe.'
field :deleted_jobs,
GraphQL::INT_TYPE,
null: true,
description: 'The number of matching jobs deleted'
description: 'The number of matching jobs deleted.'
field :queue_size,
GraphQL::INT_TYPE,
null: true,
description: 'The queue size after processing'
description: 'The queue size after processing.'
end
end
end
......
app/graphql/types/alert_management/alert_status_counts_type.rb
View file @ fab4f707
......@@ -19,12 +19,12 @@ module Types
field :open,
GraphQL::INT_TYPE,
null: true,
description: 'Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project'
description: 'Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project.'
field :all,
GraphQL::INT_TYPE,
null: true,
description: 'Total number of alerts for the project'
description: 'Total number of alerts for the project.'
end
end
end
app/graphql/types/alert_management/alert_type.rb
View file @ fab4f707
......@@ -15,115 +15,115 @@ module Types
field :iid,
GraphQL::ID_TYPE,
null: false,
description: 'Internal ID of the alert'
description: 'Internal ID of the alert.'
field :issue_iid,
GraphQL::ID_TYPE,
null: true,
description: 'Internal ID of the GitLab issue attached to the alert'
description: 'Internal ID of the GitLab issue attached to the alert.'
field :title,
GraphQL::STRING_TYPE,
null: true,
description: 'Title of the alert'
description: 'Title of the alert.'
field :description,
GraphQL::STRING_TYPE,
null: true,
description: 'Description of the alert'
description: 'Description of the alert.'
field :severity,
AlertManagement::SeverityEnum,
null: true,
description: 'Severity of the alert'
description: 'Severity of the alert.'
field :status,
AlertManagement::StatusEnum,
null: true,
description: 'Status of the alert',
description: 'Status of the alert.',
method: :status_name
field :service,
GraphQL::STRING_TYPE,
null: true,
description: 'Service the alert came from'
description: 'Service the alert came from.'
field :monitoring_tool,
GraphQL::STRING_TYPE,
null: true,
description: 'Monitoring tool the alert came from'
description: 'Monitoring tool the alert came from.'
field :hosts,
[GraphQL::STRING_TYPE],
null: true,
description: 'List of hosts the alert came from'
description: 'List of hosts the alert came from.'
field :started_at,
Types::TimeType,
null: true,
description: 'Timestamp the alert was raised'
description: 'Timestamp the alert was raised.'
field :ended_at,
Types::TimeType,
null: true,
description: 'Timestamp the alert ended'
description: 'Timestamp the alert ended.'
field :environment,
Types::EnvironmentType,
null: true,
description: 'Environment for the alert'
description: 'Environment for the alert.'
field :event_count,
GraphQL::INT_TYPE,
null: true,
description: 'Number of events of this alert',
description: 'Number of events of this alert.',
method: :events
field :details, # rubocop:disable Graphql/JSONType
GraphQL::Types::JSON,
null: true,
description: 'Alert details'
description: 'Alert details.'
field :created_at,
Types::TimeType,
null: true,
description: 'Timestamp the alert was created'
description: 'Timestamp the alert was created.'
field :updated_at,
Types::TimeType,
null: true,
description: 'Timestamp the alert was last updated'
description: 'Timestamp the alert was last updated.'
field :assignees,
Types::UserType.connection_type,
null: true,
description: 'Assignees of the alert'
description: 'Assignees of the alert.'
field :metrics_dashboard_url,
GraphQL::STRING_TYPE,
null: true,
description: 'URL for metrics embed for the alert'
description: 'URL for metrics embed for the alert.'
field :runbook,
GraphQL::STRING_TYPE,
null: true,
description: 'Runbook for the alert as defined in alert details'
description: 'Runbook for the alert as defined in alert details.'
field :todos,
Types::TodoType.connection_type,
null: true,
description: 'Todos of the current user for the alert',
description: 'Todos of the current user for the alert.',
resolver: Resolvers::TodoResolver
field :details_url,
GraphQL::STRING_TYPE,
null: false,
description: 'The URL of the alert detail page'
description: 'The URL of the alert detail page.'
field :prometheus_alert,
Types::PrometheusAlertType,
null: true,
description: 'The alert condition for Prometheus'
description: 'The alert condition for Prometheus.'
def notes
object.ordered_notes
......
app/graphql/types/alert_management/integration_type.rb
View file @ fab4f707
......@@ -9,37 +9,37 @@ module Types
field :id,
GraphQL::ID_TYPE,
null: false,
description: 'ID of the integration'
description: 'ID of the integration.'
field :type,
AlertManagement::IntegrationTypeEnum,
null: false,
description: 'Type of integration'
description: 'Type of integration.'
field :name,
GraphQL::STRING_TYPE,
null: true,
description: 'Name of the integration'
description: 'Name of the integration.'
field :active,
GraphQL::BOOLEAN_TYPE,
null: true,
description: 'Whether the endpoint is currently accepting alerts'
description: 'Whether the endpoint is currently accepting alerts.'
field :token,
GraphQL::STRING_TYPE,
null: true,
description: 'Token used to authenticate alert notification requests'
description: 'Token used to authenticate alert notification requests.'
field :url,
GraphQL::STRING_TYPE,
null: true,
description: 'Endpoint which accepts alert notifications'
description: 'Endpoint which accepts alert notifications.'
field :api_url,
GraphQL::STRING_TYPE,
null: true,
description: 'URL at which Prometheus metrics can be queried to populate the metrics dashboard'
description: 'URL at which Prometheus metrics can be queried to populate the metrics dashboard.'
definition_methods do
def resolve_type(object, context)
......
app/graphql/types/award_emojis/award_emoji_type.rb
View file @ fab4f707
......@@ -13,32 +13,32 @@ module Types
field :name,
GraphQL::STRING_TYPE,
null: false,
description: 'The emoji name'
description: 'The emoji name.'
field :description,
GraphQL::STRING_TYPE,
null: false,
description: 'The emoji description'
description: 'The emoji description.'
field :unicode,
GraphQL::STRING_TYPE,
null: false,
description: 'The emoji in unicode'
description: 'The emoji in unicode.'
field :emoji,
GraphQL::STRING_TYPE,
null: false,
description: 'The emoji as an icon'
description: 'The emoji as an icon.'
field :unicode_version,
GraphQL::STRING_TYPE,
null: false,
description: 'The unicode version for this emoji'
description: 'The unicode version for this emoji.'
field :user,
Types::UserType,
null: false,
description: 'The user who awarded the emoji'
description: 'The user who awarded the emoji.'
def user
Gitlab::Graphql::Loaders::BatchModelLoader.new(User, object.user_id).find
......
app/graphql/types/board_list_type.rb
View file @ fab4f707
......@@ -9,22 +9,22 @@ module Types
description 'Represents a list for an issue board'
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID (global ID) of the list'
description: 'ID (global ID) of the list.'
field :title, GraphQL::STRING_TYPE, null: false,
description: 'Title of the list'
description: 'Title of the list.'
field :list_type, GraphQL::STRING_TYPE, null: false,
description: 'Type of the list'
description: 'Type of the list.'
field :position, GraphQL::INT_TYPE, null: true,
description: 'Position of list within the board'
description: 'Position of list within the board.'
field :label, Types::LabelType, null: true,
description: 'Label of the list'
description: 'Label of the list.'
field :collapsed, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if list is collapsed for this user'
description: 'Indicates if list is collapsed for this user.'
field :issues_count, GraphQL::INT_TYPE, null: true,
description: 'Count of issues in the list'
description: 'Count of issues in the list.'
field :issues, ::Types::IssueType.connection_type, null: true,
description: 'Board issues',
description: 'Board issues.',
resolver: ::Resolvers::BoardListIssuesResolver
def issues_count
......
app/graphql/types/board_type.rb
View file @ fab4f707
......@@ -10,20 +10,20 @@ module Types
present_using BoardPresenter
field :id, type: GraphQL::ID_TYPE, null: false,
description: 'ID (global ID) of the board'
description: 'ID (global ID) of the board.'
field :name, type: GraphQL::STRING_TYPE, null: true,
description: 'Name of the board'
description: 'Name of the board.'
field :hide_backlog_list, type: GraphQL::BOOLEAN_TYPE, null: true,
description: 'Whether or not backlog list is hidden'
description: 'Whether or not backlog list is hidden.'
field :hide_closed_list, type: GraphQL::BOOLEAN_TYPE, null: true,
description: 'Whether or not closed list is hidden'
description: 'Whether or not closed list is hidden.'
field :lists,
Types::BoardListType.connection_type,
null: true,
description: 'Lists of the board',
description: 'Lists of the board.',
resolver: Resolvers::BoardListsResolver,
extras: [:lookahead]
......
app/graphql/types/boards/board_issue_input_base_type.rb
View file @ fab4f707
......@@ -6,27 +6,27 @@ module Types
class BoardIssueInputBaseType < BaseInputObject
argument :label_name, GraphQL::STRING_TYPE.to_list_type,
required: false,
description: 'Filter by label name'
description: 'Filter by label name.'
argument :milestone_title, GraphQL::STRING_TYPE,
required: false,
description: 'Filter by milestone title'
description: 'Filter by milestone title.'
argument :assignee_username, GraphQL::STRING_TYPE.to_list_type,
required: false,
description: 'Filter by assignee username'
description: 'Filter by assignee username.'
argument :author_username, GraphQL::STRING_TYPE,
required: false,
description: 'Filter by author username'
description: 'Filter by author username.'
argument :release_tag, GraphQL::STRING_TYPE,
required: false,
description: 'Filter by release tag'
description: 'Filter by release tag.'
argument :my_reaction_emoji, GraphQL::STRING_TYPE,
required: false,
description: 'Filter by reaction emoji'
description: 'Filter by reaction emoji.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/boards/board_issue_input_type.rb
View file @ fab4f707
......@@ -11,11 +11,11 @@ module Types
argument :not, NegatedBoardIssueInputType,
required: false,
description: 'List of negated params. Warning: this argument is experimental and a subject to change in future'
description: 'List of negated params. Warning: this argument is experimental and a subject to change in future.'
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Search query for issue title or description'
description: 'Search query for issue title or description.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/branch_type.rb
View file @ fab4f707
......@@ -8,11 +8,11 @@ module Types
field :name,
GraphQL::STRING_TYPE,
null: false,
description: 'Name of the branch'
description: 'Name of the branch.'
field :commit, Types::CommitType,
null: true, resolver: Resolvers::BranchCommitResolver,
description: 'Commit for the branch'
description: 'Commit for the branch.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
app/graphql/types/ci/analytics_type.rb
View file @ fab4f707
......@@ -7,27 +7,27 @@ module Types
graphql_name 'PipelineAnalytics'
field :week_pipelines_totals, [GraphQL::INT_TYPE], null: true,
description: 'Total weekly pipeline count'
description: 'Total weekly pipeline count.'
field :week_pipelines_successful, [GraphQL::INT_TYPE], null: true,
description: 'Total weekly successful pipeline count'
description: 'Total weekly successful pipeline count.'
field :week_pipelines_labels, [GraphQL::STRING_TYPE], null: true,
description: 'Labels for the weekly pipeline count'
description: 'Labels for the weekly pipeline count.'
field :month_pipelines_totals, [GraphQL::INT_TYPE], null: true,
description: 'Total monthly pipeline count'
description: 'Total monthly pipeline count.'
field :month_pipelines_successful, [GraphQL::INT_TYPE], null: true,
description: 'Total monthly successful pipeline count'
description: 'Total monthly successful pipeline count.'
field :month_pipelines_labels, [GraphQL::STRING_TYPE], null: true,
description: 'Labels for the monthly pipeline count'
description: 'Labels for the monthly pipeline count.'
field :year_pipelines_totals, [GraphQL::INT_TYPE], null: true,
description: 'Total yearly pipeline count'
description: 'Total yearly pipeline count.'
field :year_pipelines_successful, [GraphQL::INT_TYPE], null: true,
description: 'Total yearly successful pipeline count'
description: 'Total yearly successful pipeline count.'
field :year_pipelines_labels, [GraphQL::STRING_TYPE], null: true,
description: 'Labels for the yearly pipeline count'
description: 'Labels for the yearly pipeline count.'
field :pipeline_times_values, [GraphQL::INT_TYPE], null: true,
description: 'Pipeline times'
description: 'Pipeline times.'
field :pipeline_times_labels, [GraphQL::STRING_TYPE], null: true,
description: 'Pipeline times labels'
description: 'Pipeline times labels.'
end
end
end
app/graphql/types/ci/config/config_type.rb
View file @ fab4f707
......@@ -8,13 +8,13 @@ module Types
graphql_name 'CiConfig'
field :errors, [GraphQL::STRING_TYPE], null: true,
description: 'Linting errors'
description: 'Linting errors.'
field :merged_yaml, GraphQL::STRING_TYPE, null: true,
description: 'Merged CI config YAML'
description: 'Merged CI config YAML.'
field :stages, Types::Ci::Config::StageType.connection_type, null: true,
description: 'Stages of the pipeline'
description: 'Stages of the pipeline.'
field :status, Types::Ci::Config::StatusEnum, null: true,
description: 'Status of linting, can be either valid or invalid'
description: 'Status of linting, can be either valid or invalid.'
end
end
end
......
app/graphql/types/ci/config/group_type.rb
View file @ fab4f707
......@@ -8,11 +8,11 @@ module Types
graphql_name 'CiConfigGroup'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the job group'
description: 'Name of the job group.'
field :jobs, Types::Ci::Config::JobType.connection_type, null: true,
description: 'Jobs in group'
description: 'Jobs in group.'
field :size, GraphQL::INT_TYPE, null: true,
description: 'Size of the job group'
description: 'Size of the job group.'
end
end
end
......
app/graphql/types/ci/config/need_type.rb
View file @ fab4f707
......@@ -8,7 +8,7 @@ module Types
graphql_name 'CiConfigNeed'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the need'
description: 'Name of the need.'
end
end
end
......
app/graphql/types/ci/config/stage_type.rb
View file @ fab4f707
......@@ -8,9 +8,9 @@ module Types
graphql_name 'CiConfigStage'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the stage'
description: 'Name of the stage.'
field :groups, Types::Ci::Config::GroupType.connection_type, null: true,
description: 'Groups of jobs for the stage'
description: 'Groups of jobs for the stage.'
end
end
end
......
app/graphql/types/ci/detailed_status_type.rb
View file @ fab4f707
......@@ -7,26 +7,26 @@ module Types
graphql_name 'DetailedStatus'
field :group, GraphQL::STRING_TYPE, null: true,
description: 'Group of the status'
description: 'Group of the status.'
field :icon, GraphQL::STRING_TYPE, null: true,
description: 'Icon of the status'
description: 'Icon of the status.'
field :favicon, GraphQL::STRING_TYPE, null: true,
description: 'Favicon of the status'
description: 'Favicon of the status.'
field :details_path, GraphQL::STRING_TYPE, null: true,
description: 'Path of the details for the status'
description: 'Path of the details for the status.'
field :has_details, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the status has further details',
description: 'Indicates if the status has further details.',
method: :has_details?
field :label, GraphQL::STRING_TYPE, null: true,
description: 'Label of the status'
description: 'Label of the status.'
field :text, GraphQL::STRING_TYPE, null: true,
description: 'Text of the status'
description: 'Text of the status.'
field :tooltip, GraphQL::STRING_TYPE, null: true,
description: 'Tooltip associated with the status',
description: 'Tooltip associated with the status.',
method: :status_tooltip
field :action, Types::Ci::StatusActionType, null: true,
calls_gitaly: true,
description: 'Action information for the status. This includes method, button title, icon, path, and title'
description: 'Action information for the status. This includes method, button title, icon, path, and title.'
def action
if object.has_action?
......
app/graphql/types/ci/group_type.rb
View file @ fab4f707
......@@ -7,13 +7,13 @@ module Types
graphql_name 'CiGroup'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the job group'
description: 'Name of the job group.'
field :size, GraphQL::INT_TYPE, null: true,
description: 'Size of the group'
description: 'Size of the group.'
field :jobs, Ci::JobType.connection_type, null: true,
description: 'Jobs in group'
description: 'Jobs in group.'
field :detailed_status, Types::Ci::DetailedStatusType, null: true,
description: 'Detailed status of the group'
description: 'Detailed status of the group.'
def detailed_status
object.detailed_status(context[:current_user])
......
app/graphql/types/ci/job_artifact_type.rb
View file @ fab4f707
......@@ -7,10 +7,10 @@ module Types
graphql_name 'CiJobArtifact'
field :download_path, GraphQL::STRING_TYPE, null: true,
description: "URL for downloading the artifact's file"
description: "URL for downloading the artifact's file."
field :file_type, ::Types::Ci::JobArtifactFileTypeEnum, null: true,
description: 'File type of the artifact'
description: 'File type of the artifact.'
def download_path
::Gitlab::Routing.url_helpers.download_project_job_artifacts_path(
......
app/graphql/types/ci/job_type.rb
View file @ fab4f707
......@@ -7,17 +7,17 @@ module Types
authorize :read_commit_status
field :pipeline, Types::Ci::PipelineType, null: true,
description: 'Pipeline the job belongs to'
description: 'Pipeline the job belongs to.'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the job'
description: 'Name of the job.'
field :needs, BuildNeedType.connection_type, null: true,
description: 'References to builds that must complete before the jobs run'
description: 'References to builds that must complete before the jobs run.'
field :detailed_status, Types::Ci::DetailedStatusType, null: true,
description: 'Detailed status of the job'
description: 'Detailed status of the job.'
field :scheduled_at, Types::TimeType, null: true,
description: 'Schedule for the build'
description: 'Schedule for the build.'
field :artifacts, Types::Ci::JobArtifactType.connection_type, null: true,
description: 'Artifacts generated by the job'
description: 'Artifacts generated by the job.'
def pipeline
Gitlab::Graphql::Loaders::BatchModelLoader.new(::Ci::Pipeline, object.pipeline_id).find
......
app/graphql/types/ci/pipeline_type.rb
View file @ fab4f707
......@@ -12,90 +12,90 @@ module Types
expose_permissions Types::PermissionTypes::Ci::Pipeline
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the pipeline'
description: 'ID of the pipeline.'
field :iid, GraphQL::STRING_TYPE, null: false,
description: 'Internal ID of the pipeline'
description: 'Internal ID of the pipeline.'
field :sha, GraphQL::STRING_TYPE, null: false,
description: "SHA of the pipeline's commit"
description: "SHA of the pipeline's commit."
field :before_sha, GraphQL::STRING_TYPE, null: true,
description: 'Base SHA of the source branch'
description: 'Base SHA of the source branch.'
field :status, PipelineStatusEnum, null: false,
description: "Status of the pipeline (#{::Ci::Pipeline.all_state_names.compact.join(', ').upcase})"
field :detailed_status, Types::Ci::DetailedStatusType, null: false,
description: 'Detailed status of the pipeline'
description: 'Detailed status of the pipeline.'
field :config_source, PipelineConfigSourceEnum, null: true,
description: "Config source of the pipeline (#{::Enums::Ci::Pipeline.config_sources.keys.join(', ').upcase})"
field :duration, GraphQL::INT_TYPE, null: true,
description: 'Duration of the pipeline in seconds'
description: 'Duration of the pipeline in seconds.'
field :coverage, GraphQL::FLOAT_TYPE, null: true,
description: 'Coverage percentage'
description: 'Coverage percentage.'
field :created_at, Types::TimeType, null: false,
description: "Timestamp of the pipeline's creation"
description: "Timestamp of the pipeline's creation."
field :updated_at, Types::TimeType, null: false,
description: "Timestamp of the pipeline's last activity"
description: "Timestamp of the pipeline's last activity."
field :started_at, Types::TimeType, null: true,
description: 'Timestamp when the pipeline was started'
description: 'Timestamp when the pipeline was started.'
field :finished_at, Types::TimeType, null: true,
description: "Timestamp of the pipeline's completion"
description: "Timestamp of the pipeline's completion."
field :committed_at, Types::TimeType, null: true,
description: "Timestamp of the pipeline's commit"
description: "Timestamp of the pipeline's commit."
field :stages, Types::Ci::StageType.connection_type, null: true,
description: 'Stages of the pipeline',
description: 'Stages of the pipeline.',
extras: [:lookahead],
resolver: Resolvers::Ci::PipelineStagesResolver
field :user, Types::UserType, null: true,
description: 'Pipeline user'
description: 'Pipeline user.'
field :retryable, GraphQL::BOOLEAN_TYPE,
description: 'Specifies if a pipeline can be retried',
description: 'Specifies if a pipeline can be retried.',
method: :retryable?,
null: false
field :cancelable, GraphQL::BOOLEAN_TYPE,
description: 'Specifies if a pipeline can be canceled',
description: 'Specifies if a pipeline can be canceled.',
method: :cancelable?,
null: false
field :jobs,
::Types::Ci::JobType.connection_type,
null: true,
description: 'Jobs belonging to the pipeline',
description: 'Jobs belonging to the pipeline.',
resolver: ::Resolvers::Ci::JobsResolver
field :source_job, Types::Ci::JobType, null: true,
description: 'Job where pipeline was triggered from'
description: 'Job where pipeline was triggered from.'
field :downstream, Types::Ci::PipelineType.connection_type, null: true,
description: 'Pipelines this pipeline will trigger',
description: 'Pipelines this pipeline will trigger.',
method: :triggered_pipelines_with_preloads
field :upstream, Types::Ci::PipelineType, null: true,
description: 'Pipeline that triggered the pipeline',
description: 'Pipeline that triggered the pipeline.',
method: :triggered_by_pipeline
field :path, GraphQL::STRING_TYPE, null: true,
description: "Relative path to the pipeline's page"
description: "Relative path to the pipeline's page."
field :project, Types::ProjectType, null: true,
description: 'Project the pipeline belongs to'
description: 'Project the pipeline belongs to.'
field :active, GraphQL::BOOLEAN_TYPE, null: false, method: :active?,
description: 'Indicates if the pipeline is active'
description: 'Indicates if the pipeline is active.'
def detailed_status
object.detailed_status(context[:current_user])
......
app/graphql/types/ci/runner_architecture_type.rb
View file @ fab4f707
......@@ -7,9 +7,9 @@ module Types
graphql_name 'RunnerArchitecture'
field :name, GraphQL::STRING_TYPE, null: false,
description: 'Name of the runner platform architecture'
description: 'Name of the runner platform architecture.'
field :download_location, GraphQL::STRING_TYPE, null: false,
description: 'Download location for the runner for the platform architecture'
description: 'Download location for the runner for the platform architecture.'
end
end
end
app/graphql/types/ci/runner_platform_type.rb
View file @ fab4f707
......@@ -7,11 +7,11 @@ module Types
graphql_name 'RunnerPlatform'
field :name, GraphQL::STRING_TYPE, null: false,
description: 'Name slug of the runner platform'
description: 'Name slug of the runner platform.'
field :human_readable_name, GraphQL::STRING_TYPE, null: false,
description: 'Human readable name of the runner platform'
description: 'Human readable name of the runner platform.'
field :architectures, Types::Ci::RunnerArchitectureType.connection_type, null: true,
description: 'Runner architectures supported for the platform'
description: 'Runner architectures supported for the platform.'
end
end
end
app/graphql/types/ci/runner_setup_type.rb
View file @ fab4f707
......@@ -7,9 +7,9 @@ module Types
graphql_name 'RunnerSetup'
field :install_instructions, GraphQL::STRING_TYPE, null: false,
description: 'Instructions for installing the runner on the specified architecture'
description: 'Instructions for installing the runner on the specified architecture.'
field :register_instructions, GraphQL::STRING_TYPE, null: true,
description: 'Instructions for registering the runner'
description: 'Instructions for registering the runner.'
end
end
end
app/graphql/types/ci/stage_type.rb
View file @ fab4f707
......@@ -7,12 +7,12 @@ module Types
graphql_name 'CiStage'
field :name, GraphQL::STRING_TYPE, null: true,
description: 'Name of the stage'
description: 'Name of the stage.'
field :groups, Ci::GroupType.connection_type, null: true,
extras: [:lookahead],
description: 'Group of jobs for the stage'
description: 'Group of jobs for the stage.'
field :detailed_status, Types::Ci::DetailedStatusType, null: true,
description: 'Detailed status of the stage'
description: 'Detailed status of the stage.'
def detailed_status
object.detailed_status(context[:current_user])
......
app/graphql/types/ci/status_action_type.rb
View file @ fab4f707
......@@ -6,16 +6,16 @@ module Types
graphql_name 'StatusAction'
field :button_title, GraphQL::STRING_TYPE, null: true,
description: 'Title for the button, for example: Retry this job'
description: 'Title for the button, for example: Retry this job.'
field :icon, GraphQL::STRING_TYPE, null: true,
description: 'Icon used in the action button'
description: 'Icon used in the action button.'
field :method, GraphQL::STRING_TYPE, null: true,
description: 'Method for the action, for example: :post',
description: 'Method for the action, for example: :post.',
resolver_method: :action_method
field :path, GraphQL::STRING_TYPE, null: true,
description: 'Path for the action'
description: 'Path for the action.'
field :title, GraphQL::STRING_TYPE, null: true,
description: 'Title for the action, for example: Retry'
description: 'Title for the action, for example: Retry.'
def action_method
object[:method]
......
app/graphql/types/commit_action_type.rb
View file @ fab4f707
......@@ -4,19 +4,19 @@ module Types
# rubocop: disable Graphql/AuthorizeTypes
class CommitActionType < BaseInputObject
argument :action, type: Types::CommitActionModeEnum, required: true,
description: 'The action to perform, create, delete, move, update, chmod'
description: 'The action to perform, create, delete, move, update, chmod.'
argument :file_path, type: GraphQL::STRING_TYPE, required: true,
description: 'Full path to the file'
description: 'Full path to the file.'
argument :content, type: GraphQL::STRING_TYPE, required: false,
description: 'Content of the file'
description: 'Content of the file.'
argument :previous_path, type: GraphQL::STRING_TYPE, required: false,
description: 'Original full path to the file being moved'
description: 'Original full path to the file being moved.'
argument :last_commit_id, type: GraphQL::STRING_TYPE, required: false,
description: 'Last known file commit ID'
description: 'Last known file commit ID.'
argument :execute_filemode, type: GraphQL::BOOLEAN_TYPE, required: false,
description: 'Enables/disables the execute flag on the file'
description: 'Enables/disables the execute flag on the file.'
argument :encoding, type: Types::CommitEncodingEnum, required: false,
description: 'Encoding of the file. Default is text'
description: 'Encoding of the file. Default is text.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
app/graphql/types/commit_type.rb
View file @ fab4f707
......@@ -9,39 +9,39 @@ module Types
present_using CommitPresenter
field :id, type: GraphQL::ID_TYPE, null: false,
description: 'ID (global ID) of the commit'
description: 'ID (global ID) of the commit.'
field :sha, type: GraphQL::STRING_TYPE, null: false,
description: 'SHA1 ID of the commit'
description: 'SHA1 ID of the commit.'
field :short_id, type: GraphQL::STRING_TYPE, null: false,
description: 'Short SHA1 ID of the commit'
description: 'Short SHA1 ID of the commit.'
field :title, type: GraphQL::STRING_TYPE, null: true, calls_gitaly: true,
description: 'Title of the commit message'
description: 'Title of the commit message.'
markdown_field :title_html, null: true
field :description, type: GraphQL::STRING_TYPE, null: true,
description: 'Description of the commit message'
description: 'Description of the commit message.'
markdown_field :description_html, null: true
field :message, type: GraphQL::STRING_TYPE, null: true,
description: 'Raw commit message'
description: 'Raw commit message.'
field :authored_date, type: Types::TimeType, null: true,
description: 'Timestamp of when the commit was authored'
description: 'Timestamp of when the commit was authored.'
field :web_url, type: GraphQL::STRING_TYPE, null: false,
description: 'Web URL of the commit'
description: 'Web URL of the commit.'
field :web_path, type: GraphQL::STRING_TYPE, null: false,
description: 'Web path of the commit'
description: 'Web path of the commit.'
field :signature_html, type: GraphQL::STRING_TYPE, null: true, calls_gitaly: true,
description: 'Rendered HTML of the commit signature'
description: 'Rendered HTML of the commit signature.'
field :author_name, type: GraphQL::STRING_TYPE, null: true,
description: 'Commit authors name'
description: 'Commit authors name.'
field :author_gravatar, type: GraphQL::STRING_TYPE, null: true,
description: 'Commit authors gravatar'
description: 'Commit authors gravatar.'
# models/commit lazy loads the author by email
field :author, type: Types::UserType, null: true,
description: 'Author of the commit'
description: 'Author of the commit.'
field :pipelines,
null: true,
description: 'Pipelines of the commit ordered latest first',
description: 'Pipelines of the commit ordered latest first.',
resolver: Resolvers::CommitPipelinesResolver
def author_gravatar
......
app/graphql/types/container_expiration_policy_type.rb
View file @ fab4f707
......@@ -8,14 +8,14 @@ module Types
authorize :destroy_container_image
field :created_at, Types::TimeType, null: false, description: 'Timestamp of when the container expiration policy was created'
field :updated_at, Types::TimeType, null: false, description: 'Timestamp of when the container expiration policy was updated'
field :enabled, GraphQL::BOOLEAN_TYPE, null: false, description: 'Indicates whether this container expiration policy is enabled'
field :older_than, Types::ContainerExpirationPolicyOlderThanEnum, null: true, description: 'Tags older that this will expire'
field :cadence, Types::ContainerExpirationPolicyCadenceEnum, null: false, description: 'This container expiration policy schedule'
field :keep_n, Types::ContainerExpirationPolicyKeepEnum, null: true, description: 'Number of tags to retain'
field :name_regex, Types::UntrustedRegexp, null: true, description: 'Tags with names matching this regex pattern will expire'
field :name_regex_keep, Types::UntrustedRegexp, null: true, description: 'Tags with names matching this regex pattern will be preserved'
field :next_run_at, Types::TimeType, null: true, description: 'Next time that this container expiration policy will get executed'
field :created_at, Types::TimeType, null: false, description: 'Timestamp of when the container expiration policy was created.'
field :updated_at, Types::TimeType, null: false, description: 'Timestamp of when the container expiration policy was updated.'
field :enabled, GraphQL::BOOLEAN_TYPE, null: false, description: 'Indicates whether this container expiration policy is enabled.'
field :older_than, Types::ContainerExpirationPolicyOlderThanEnum, null: true, description: 'Tags older that this will expire.'
field :cadence, Types::ContainerExpirationPolicyCadenceEnum, null: false, description: 'This container expiration policy schedule.'
field :keep_n, Types::ContainerExpirationPolicyKeepEnum, null: true, description: 'Number of tags to retain.'
field :name_regex, Types::UntrustedRegexp, null: true, description: 'Tags with names matching this regex pattern will expire.'
field :name_regex_keep, Types::UntrustedRegexp, null: true, description: 'Tags with names matching this regex pattern will be preserved.'
field :next_run_at, Types::TimeType, null: true, description: 'Next time that this container expiration policy will get executed.'
end
end
app/graphql/types/container_repository_details_type.rb
View file @ fab4f707
......@@ -11,7 +11,7 @@ module Types
field :tags,
Types::ContainerRepositoryTagType.connection_type,
null: true,
description: 'Tags of the container repository',
description: 'Tags of the container repository.',
max_page_size: 20
def can_delete
......
app/graphql/types/container_repository_type.rb
View file @ fab4f707
......@@ -19,7 +19,7 @@ module Types
field :status, Types::ContainerRepositoryStatusEnum, null: true, description: 'Status of the container repository.'
field :tags_count, GraphQL::INT_TYPE, null: false, description: 'Number of tags associated with this image.'
field :can_delete, GraphQL::BOOLEAN_TYPE, null: false, description: 'Can the current user delete the container repository.'
field :project, Types::ProjectType, null: false, description: 'Project of the container registry'
field :project, Types::ProjectType, null: false, description: 'Project of the container registry.'
def can_delete
Ability.allowed?(current_user, :update_container_image, object)
......
app/graphql/types/countable_connection_type.rb
View file @ fab4f707
......@@ -4,7 +4,7 @@ module Types
# rubocop: disable Graphql/AuthorizeTypes
class CountableConnectionType < GraphQL::Types::Relay::BaseConnection
field :count, GraphQL::INT_TYPE, null: false,
description: 'Total count of collection'
description: 'Total count of collection.'
def count
# rubocop: disable CodeReuse/ActiveRecord
......
app/graphql/types/current_user_todos.rb
View file @ fab4f707
......@@ -8,10 +8,10 @@ module Types
field_class Types::BaseField
field :current_user_todos, Types::TodoType.connection_type,
description: 'Todos for the current user',
description: 'Todos for the current user.',
null: false do
argument :state, Types::TodoStateEnum,
description: 'State of the todos',
description: 'State of the todos.',
required: false
end
......
app/graphql/types/custom_emoji_type.rb
View file @ fab4f707
......@@ -9,19 +9,19 @@ module Types
field :id, ::Types::GlobalIDType[::CustomEmoji],
null: false,
description: 'The ID of the emoji'
description: 'The ID of the emoji.'
field :name, GraphQL::STRING_TYPE,
null: false,
description: 'The name of the emoji'
description: 'The name of the emoji.'
field :url, GraphQL::STRING_TYPE,
null: false,
method: :file,
description: 'The link to file of the emoji'
description: 'The link to file of the emoji.'
field :external, GraphQL::BOOLEAN_TYPE,
null: false,
description: 'Whether the emoji is an external link'
description: 'Whether the emoji is an external link.'
end
end
app/graphql/types/design_management/design_at_version_type.rb
View file @ fab4f707
......@@ -18,12 +18,12 @@ module Types
field :version,
Types::DesignManagement::VersionType,
null: false,
description: 'The version this design-at-versions is pinned to'
description: 'The version this design-at-versions is pinned to.'
field :design,
Types::DesignManagement::DesignType,
null: false,
description: 'The underlying design'
description: 'The underlying design.'
def cached_stateful_version(_parent)
version
......
app/graphql/types/design_management/design_collection_type.rb
View file @ fab4f707
......@@ -9,40 +9,40 @@ module Types
authorize :read_design
field :project, Types::ProjectType, null: false,
description: 'Project associated with the design collection'
description: 'Project associated with the design collection.'
field :issue, Types::IssueType, null: false,
description: 'Issue associated with the design collection'
description: 'Issue associated with the design collection.'
field :designs,
Types::DesignManagement::DesignType.connection_type,
null: false,
resolver: Resolvers::DesignManagement::DesignsResolver,
description: 'All designs for the design collection',
description: 'All designs for the design collection.',
complexity: 5
field :versions,
Types::DesignManagement::VersionType.connection_type,
resolver: Resolvers::DesignManagement::VersionsResolver,
description: 'All versions related to all designs, ordered newest first'
description: 'All versions related to all designs, ordered newest first.'
field :version,
Types::DesignManagement::VersionType,
resolver: Resolvers::DesignManagement::VersionsResolver.single,
description: 'A specific version'
description: 'A specific version.'
field :design_at_version, ::Types::DesignManagement::DesignAtVersionType,
null: true,
resolver: ::Resolvers::DesignManagement::DesignAtVersionResolver,
description: 'Find a design as of a version'
description: 'Find a design as of a version.'
field :design, ::Types::DesignManagement::DesignType,
null: true,
resolver: ::Resolvers::DesignManagement::DesignResolver,
description: 'Find a specific design'
description: 'Find a specific design.'
field :copy_state, ::Types::DesignManagement::DesignCollectionCopyStateEnum,
null: true,
description: 'Copy state of the design collection'
description: 'Copy state of the design collection.'
end
end
end
app/graphql/types/design_management/design_fields.rb
View file @ fab4f707
......@@ -7,12 +7,12 @@ module Types
field_class Types::BaseField
field :id, GraphQL::ID_TYPE, description: 'The ID of this design', null: false
field :project, Types::ProjectType, null: false, description: 'The project the design belongs to'
field :issue, Types::IssueType, null: false, description: 'The issue the design belongs to'
field :filename, GraphQL::STRING_TYPE, null: false, description: 'The filename of the design'
field :full_path, GraphQL::STRING_TYPE, null: false, description: 'The full path to the design file'
field :image, GraphQL::STRING_TYPE, null: false, extras: [:parent], description: 'The URL of the full-sized image'
field :id, GraphQL::ID_TYPE, description: 'The ID of this design.', null: false
field :project, Types::ProjectType, null: false, description: 'The project the design belongs to.'
field :issue, Types::IssueType, null: false, description: 'The issue the design belongs to.'
field :filename, GraphQL::STRING_TYPE, null: false, description: 'The filename of the design.'
field :full_path, GraphQL::STRING_TYPE, null: false, description: 'The full path to the design file.'
field :image, GraphQL::STRING_TYPE, null: false, extras: [:parent], description: 'The URL of the full-sized image.'
field :image_v432x230, GraphQL::STRING_TYPE, null: true, extras: [:parent],
description: 'The URL of the design resized to fit within the bounds of 432x230. ' \
'This will be `null` if the image has not been generated'
......@@ -20,16 +20,16 @@ module Types
null: false,
calls_gitaly: true,
extras: [:parent],
description: 'The diff refs for this design'
description: 'The diff refs for this design.'
field :event, Types::DesignManagement::DesignVersionEventEnum,
null: false,
extras: [:parent],
description: 'How this design was changed in the current version'
description: 'How this design was changed in the current version.'
field :notes_count,
GraphQL::INT_TYPE,
null: false,
method: :user_notes_count,
description: 'The total count of user-created notes for this design'
description: 'The total count of user-created notes for this design.'
def diff_refs(parent:)
version = cached_stateful_version(parent)
......
app/graphql/types/design_management/design_type.rb
View file @ fab4f707
......@@ -17,7 +17,7 @@ module Types
field :versions,
Types::DesignManagement::VersionType.connection_type,
resolver: Resolvers::DesignManagement::VersionsResolver,
description: "All versions related to this design ordered newest first",
description: "All versions related to this design ordered newest first.",
extras: [:parent]
# Returns a `DesignManagement::Version` for this query based on the
......
app/graphql/types/design_management/version_type.rb
View file @ fab4f707
......@@ -12,25 +12,25 @@ module Types
authorize :read_design
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the design version'
description: 'ID of the design version.'
field :sha, GraphQL::ID_TYPE, null: false,
description: 'SHA of the design version'
description: 'SHA of the design version.'
field :designs,
::Types::DesignManagement::DesignType.connection_type,
null: false,
description: 'All designs that were changed in the version'
description: 'All designs that were changed in the version.'
field :designs_at_version,
::Types::DesignManagement::DesignAtVersionType.connection_type,
null: false,
description: 'All designs that are visible at this version, as of this version',
description: 'All designs that are visible at this version, as of this version.',
resolver: ::Resolvers::DesignManagement::Version::DesignsAtVersionResolver
field :design_at_version,
::Types::DesignManagement::DesignAtVersionType,
null: false,
description: 'A particular design as of this version, provided it is visible at this version',
description: 'A particular design as of this version, provided it is visible at this version.',
resolver: ::Resolvers::DesignManagement::Version::DesignsAtVersionResolver.single
end
end
......
app/graphql/types/design_management_type.rb
View file @ fab4f707
......@@ -8,11 +8,11 @@ module Types
field :version, ::Types::DesignManagement::VersionType,
null: true,
resolver: ::Resolvers::DesignManagement::VersionResolver,
description: 'Find a version'
description: 'Find a version.'
field :design_at_version, ::Types::DesignManagement::DesignAtVersionType,
null: true,
resolver: ::Resolvers::DesignManagement::DesignAtVersionResolver,
description: 'Find a design as of a version'
description: 'Find a design as of a version.'
end
end
app/graphql/types/diff_paths_input_type.rb
View file @ fab4f707
......@@ -4,9 +4,9 @@ module Types
# rubocop: disable Graphql/AuthorizeTypes
class DiffPathsInputType < BaseInputObject
argument :old_path, GraphQL::STRING_TYPE, required: false,
description: 'The path of the file on the start sha'
description: 'The path of the file on the start sha.'
argument :new_path, GraphQL::STRING_TYPE, required: false,
description: 'The path of the file on the head sha'
description: 'The path of the file on the head sha.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
app/graphql/types/diff_refs_type.rb
View file @ fab4f707
......@@ -7,11 +7,11 @@ module Types
graphql_name 'DiffRefs'
field :head_sha, GraphQL::STRING_TYPE, null: false,
description: 'SHA of the HEAD at the time the comment was made'
description: 'SHA of the HEAD at the time the comment was made.'
field :base_sha, GraphQL::STRING_TYPE, null: true,
description: 'Merge base of the branch the comment was made on'
description: 'Merge base of the branch the comment was made on.'
field :start_sha, GraphQL::STRING_TYPE, null: false,
description: 'SHA of the branch being compared against'
description: 'SHA of the branch being compared against.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
app/graphql/types/diff_stats_summary_type.rb
View file @ fab4f707
......@@ -9,13 +9,13 @@ module Types
description 'Aggregated summary of changes'
field :additions, GraphQL::INT_TYPE, null: false,
description: 'Number of lines added'
description: 'Number of lines added.'
field :deletions, GraphQL::INT_TYPE, null: false,
description: 'Number of lines deleted'
description: 'Number of lines deleted.'
field :changes, GraphQL::INT_TYPE, null: false,
description: 'Number of lines changed'
description: 'Number of lines changed.'
field :file_count, GraphQL::INT_TYPE, null: false,
description: 'Number of files changed'
description: 'Number of files changed.'
def changes
object[:additions] + object[:deletions]
......
app/graphql/types/diff_stats_type.rb
View file @ fab4f707
......@@ -9,11 +9,11 @@ module Types
description 'Changes to a single file'
field :path, GraphQL::STRING_TYPE, null: false,
description: 'File path, relative to repository root'
description: 'File path, relative to repository root.'
field :additions, GraphQL::INT_TYPE, null: false,
description: 'Number of lines added to this file'
description: 'Number of lines added to this file.'
field :deletions, GraphQL::INT_TYPE, null: false,
description: 'Number of lines deleted from this file'
description: 'Number of lines deleted from this file.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
app/graphql/types/environment_type.rb
View file @ fab4f707
......@@ -10,24 +10,24 @@ module Types
authorize :read_environment
field :name, GraphQL::STRING_TYPE, null: false,
description: 'Human-readable name of the environment'
description: 'Human-readable name of the environment.'
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the environment'
description: 'ID of the environment.'
field :state, GraphQL::STRING_TYPE, null: false,
description: 'State of the environment, for example: available/stopped'
description: 'State of the environment, for example: available/stopped.'
field :path, GraphQL::STRING_TYPE, null: false,
description: 'The path to the environment.'
field :metrics_dashboard, Types::Metrics::DashboardType, null: true,
description: 'Metrics dashboard schema for the environment',
description: 'Metrics dashboard schema for the environment.',
resolver: Resolvers::Metrics::DashboardResolver
field :latest_opened_most_severe_alert,
Types::AlertManagement::AlertType,
null: true,
description: 'The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned'
description: 'The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.'
end
end
app/graphql/types/error_tracking/sentry_detailed_error_type.rb
View file @ fab4f707
......@@ -12,93 +12,93 @@ module Types
field :id, GraphQL::ID_TYPE,
null: false,
description: 'ID (global ID) of the error'
description: 'ID (global ID) of the error.'
field :sentry_id, GraphQL::STRING_TYPE,
method: :id,
null: false,
description: 'ID (Sentry ID) of the error'
description: 'ID (Sentry ID) of the error.'
field :title, GraphQL::STRING_TYPE,
null: false,
description: 'Title of the error'
description: 'Title of the error.'
field :type, GraphQL::STRING_TYPE,
null: false,
description: 'Type of the error'
description: 'Type of the error.'
field :user_count, GraphQL::INT_TYPE,
null: false,
description: 'Count of users affected by the error'
description: 'Count of users affected by the error.'
field :count, GraphQL::INT_TYPE,
null: false,
description: 'Count of occurrences'
description: 'Count of occurrences.'
field :first_seen, Types::TimeType,
null: false,
description: 'Timestamp when the error was first seen'
description: 'Timestamp when the error was first seen.'
field :last_seen, Types::TimeType,
null: false,
description: 'Timestamp when the error was last seen'
description: 'Timestamp when the error was last seen.'
field :message, GraphQL::STRING_TYPE,
null: true,
description: 'Sentry metadata message of the error'
description: 'Sentry metadata message of the error.'
field :culprit, GraphQL::STRING_TYPE,
null: false,
description: 'Culprit of the error'
description: 'Culprit of the error.'
field :external_base_url, GraphQL::STRING_TYPE,
null: false,
description: 'External Base URL of the Sentry Instance'
description: 'External Base URL of the Sentry Instance.'
field :external_url, GraphQL::STRING_TYPE,
null: false,
description: 'External URL of the error'
description: 'External URL of the error.'
field :sentry_project_id, GraphQL::ID_TYPE,
method: :project_id,
null: false,
description: 'ID of the project (Sentry project)'
description: 'ID of the project (Sentry project).'
field :sentry_project_name, GraphQL::STRING_TYPE,
method: :project_name,
null: false,
description: 'Name of the project affected by the error'
description: 'Name of the project affected by the error.'
field :sentry_project_slug, GraphQL::STRING_TYPE,
method: :project_slug,
null: false,
description: 'Slug of the project affected by the error'
description: 'Slug of the project affected by the error.'
field :short_id, GraphQL::STRING_TYPE,
null: false,
description: 'Short ID (Sentry ID) of the error'
description: 'Short ID (Sentry ID) of the error.'
field :status, Types::ErrorTracking::SentryErrorStatusEnum,
null: false,
description: 'Status of the error'
description: 'Status of the error.'
field :frequency, [Types::ErrorTracking::SentryErrorFrequencyType],
null: false,
description: 'Last 24hr stats of the error'
description: 'Last 24hr stats of the error.'
field :first_release_last_commit, GraphQL::STRING_TYPE,
null: true,
description: 'Commit the error was first seen'
description: 'Commit the error was first seen.'
field :last_release_last_commit, GraphQL::STRING_TYPE,
null: true,
description: 'Commit the error was last seen'
description: 'Commit the error was last seen.'
field :first_release_short_version, GraphQL::STRING_TYPE,
null: true,
description: 'Release short version the error was first seen'
description: 'Release short version the error was first seen.'
field :last_release_short_version, GraphQL::STRING_TYPE,
null: true,
description: 'Release short version the error was last seen'
description: 'Release short version the error was last seen.'
field :first_release_version, GraphQL::STRING_TYPE,
null: true,
description: 'Release version the error was first seen'
description: 'Release version the error was first seen.'
field :last_release_version, GraphQL::STRING_TYPE,
null: true,
description: 'Release version the error was last seen'
description: 'Release version the error was last seen.'
field :gitlab_commit, GraphQL::STRING_TYPE,
null: true,
description: 'GitLab commit SHA attributed to the Error based on the release version'
description: 'GitLab commit SHA attributed to the Error based on the release version.'
field :gitlab_commit_path, GraphQL::STRING_TYPE,
null: true,
description: 'Path to the GitLab page for the GitLab commit attributed to the error'
description: 'Path to the GitLab page for the GitLab commit attributed to the error.'
field :gitlab_issue_path, GraphQL::STRING_TYPE,
method: :gitlab_issue,
null: true,
description: 'URL of GitLab Issue'
description: 'URL of GitLab Issue.'
field :tags, Types::ErrorTracking::SentryErrorTagsType,
null: false,
description: 'Tags associated with the Sentry Error'
description: 'Tags associated with the Sentry Error.'
end
end
end
app/graphql/types/error_tracking/sentry_error_collection_type.rb
View file @ fab4f707
......@@ -9,18 +9,18 @@ module Types
authorize :read_sentry_issue
field :errors,
description: "Collection of Sentry Errors",
description: "Collection of Sentry Errors.",
resolver: Resolvers::ErrorTracking::SentryErrorsResolver
field :detailed_error,
description: 'Detailed version of a Sentry error on the project',
description: 'Detailed version of a Sentry error on the project.',
resolver: Resolvers::ErrorTracking::SentryDetailedErrorResolver
field :error_stack_trace,
description: 'Stack Trace of Sentry Error',
description: 'Stack Trace of Sentry Error.',
resolver: Resolvers::ErrorTracking::SentryErrorStackTraceResolver
field :external_url,
GraphQL::STRING_TYPE,
null: true,
description: "External URL for Sentry"
description: "External URL for Sentry."
end
end
end
app/graphql/types/error_tracking/sentry_error_frequency_type.rb
View file @ fab4f707
......@@ -8,10 +8,10 @@ module Types
field :time, Types::TimeType,
null: false,
description: "Time the error frequency stats were recorded"
description: "Time the error frequency stats were recorded."
field :count, GraphQL::INT_TYPE,
null: false,
description: "Count of errors received since the previously recorded time"
description: "Count of errors received since the previously recorded time."
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/error_tracking/sentry_error_stack_trace_context_type.rb
View file @ fab4f707
......@@ -10,11 +10,11 @@ module Types
field :line,
GraphQL::INT_TYPE,
null: false,
description: 'Line number of the context'
description: 'Line number of the context.'
field :code,
GraphQL::STRING_TYPE,
null: false,
description: 'Code number of the context'
description: 'Code number of the context.'
def line
object[0]
......
app/graphql/types/error_tracking/sentry_error_stack_trace_entry_type.rb
View file @ fab4f707
......@@ -9,19 +9,19 @@ module Types
field :function, GraphQL::STRING_TYPE,
null: true,
description: 'Function in which the Sentry error occurred'
description: 'Function in which the Sentry error occurred.'
field :col, GraphQL::STRING_TYPE,
null: true,
description: 'Function in which the Sentry error occurred'
description: 'Function in which the Sentry error occurred.'
field :line, GraphQL::STRING_TYPE,
null: true,
description: 'Function in which the Sentry error occurred'
description: 'Function in which the Sentry error occurred.'
field :file_name, GraphQL::STRING_TYPE,
null: true,
description: 'File in which the Sentry error occurred'
description: 'File in which the Sentry error occurred.'
field :trace_context, [Types::ErrorTracking::SentryErrorStackTraceContextType],
null: true,
description: 'Context of the Sentry error'
description: 'Context of the Sentry error.'
def function
object['function']
......
app/graphql/types/error_tracking/sentry_error_stack_trace_type.rb
View file @ fab4f707
......@@ -10,13 +10,13 @@ module Types
field :issue_id, GraphQL::STRING_TYPE,
null: false,
description: 'ID of the Sentry error'
description: 'ID of the Sentry error.'
field :date_received, GraphQL::STRING_TYPE,
null: false,
description: 'Time the stack trace was received by Sentry'
description: 'Time the stack trace was received by Sentry.'
field :stack_trace_entries, [Types::ErrorTracking::SentryErrorStackTraceEntryType],
null: false,
description: 'Stack trace entries for the Sentry error'
description: 'Stack trace entries for the Sentry error.'
end
end
end
app/graphql/types/error_tracking/sentry_error_tags_type.rb
View file @ fab4f707
......@@ -9,10 +9,10 @@ module Types
field :level, GraphQL::STRING_TYPE,
null: true,
description: "Severity level of the Sentry Error"
description: "Severity level of the Sentry Error."
field :logger, GraphQL::STRING_TYPE,
null: true,
description: "Logger of the Sentry Error"
description: "Logger of the Sentry Error."
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/error_tracking/sentry_error_type.rb
View file @ fab4f707
......@@ -11,59 +11,59 @@ module Types
field :id, GraphQL::ID_TYPE,
null: false,
description: 'ID (global ID) of the error'
description: 'ID (global ID) of the error.'
field :sentry_id, GraphQL::STRING_TYPE,
method: :id,
null: false,
description: 'ID (Sentry ID) of the error'
description: 'ID (Sentry ID) of the error.'
field :first_seen, Types::TimeType,
null: false,
description: 'Timestamp when the error was first seen'
description: 'Timestamp when the error was first seen.'
field :last_seen, Types::TimeType,
null: false,
description: 'Timestamp when the error was last seen'
description: 'Timestamp when the error was last seen.'
field :title, GraphQL::STRING_TYPE,
null: false,
description: 'Title of the error'
description: 'Title of the error.'
field :type, GraphQL::STRING_TYPE,
null: false,
description: 'Type of the error'
description: 'Type of the error.'
field :user_count, GraphQL::INT_TYPE,
null: false,
description: 'Count of users affected by the error'
description: 'Count of users affected by the error.'
field :count, GraphQL::INT_TYPE,
null: false,
description: 'Count of occurrences'
description: 'Count of occurrences.'
field :message, GraphQL::STRING_TYPE,
null: true,
description: 'Sentry metadata message of the error'
description: 'Sentry metadata message of the error.'
field :culprit, GraphQL::STRING_TYPE,
null: false,
description: 'Culprit of the error'
description: 'Culprit of the error.'
field :external_url, GraphQL::STRING_TYPE,
null: false,
description: 'External URL of the error'
description: 'External URL of the error.'
field :short_id, GraphQL::STRING_TYPE,
null: false,
description: 'Short ID (Sentry ID) of the error'
description: 'Short ID (Sentry ID) of the error.'
field :status, Types::ErrorTracking::SentryErrorStatusEnum,
null: false,
description: 'Status of the error'
description: 'Status of the error.'
field :frequency, [Types::ErrorTracking::SentryErrorFrequencyType],
null: false,
description: 'Last 24hr stats of the error'
description: 'Last 24hr stats of the error.'
field :sentry_project_id, GraphQL::ID_TYPE,
method: :project_id,
null: false,
description: 'ID of the project (Sentry project)'
description: 'ID of the project (Sentry project).'
field :sentry_project_name, GraphQL::STRING_TYPE,
method: :project_name,
null: false,
description: 'Name of the project affected by the error'
description: 'Name of the project affected by the error.'
field :sentry_project_slug, GraphQL::STRING_TYPE,
method: :project_slug,
null: false,
description: 'Slug of the project affected by the error'
description: 'Slug of the project affected by the error.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/evidence_type.rb
View file @ fab4f707
......@@ -10,12 +10,12 @@ module Types
present_using Releases::EvidencePresenter
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the evidence'
description: 'ID of the evidence.'
field :sha, GraphQL::STRING_TYPE, null: true,
description: 'SHA1 ID of the evidence hash'
description: 'SHA1 ID of the evidence hash.'
field :filepath, GraphQL::STRING_TYPE, null: true,
description: 'URL from where the evidence can be downloaded'
description: 'URL from where the evidence can be downloaded.'
field :collected_at, Types::TimeType, null: true,
description: 'Timestamp when the evidence was collected'
description: 'Timestamp when the evidence was collected.'
end
end
app/graphql/types/grafana_integration_type.rb
View file @ fab4f707
......@@ -7,14 +7,14 @@ module Types
authorize :admin_operations
field :id, GraphQL::ID_TYPE, null: false,
description: 'Internal ID of the Grafana integration'
description: 'Internal ID of the Grafana integration.'
field :grafana_url, GraphQL::STRING_TYPE, null: false,
description: 'URL for the Grafana host for the Grafana integration'
description: 'URL for the Grafana host for the Grafana integration.'
field :enabled, GraphQL::BOOLEAN_TYPE, null: false,
description: 'Indicates whether Grafana integration is enabled'
description: 'Indicates whether Grafana integration is enabled.'
field :created_at, Types::TimeType, null: false,
description: 'Timestamp of the issue\'s creation'
description: 'Timestamp of the issue\'s creation.'
field :updated_at, Types::TimeType, null: false,
description: 'Timestamp of the issue\'s last activity'
description: 'Timestamp of the issue\'s last activity.'
end
end
app/graphql/types/group_invitation_type.rb
View file @ fab4f707
......@@ -11,7 +11,7 @@ module Types
description 'Represents a Group Invitation'
field :group, Types::GroupType, null: true,
description: 'Group that a User is invited to'
description: 'Group that a User is invited to.'
def group
Gitlab::Graphql::Loaders::BatchModelLoader.new(Group, object.source_id).find
......
app/graphql/types/group_member_type.rb
View file @ fab4f707
......@@ -11,7 +11,7 @@ module Types
description 'Represents a Group Membership'
field :group, Types::GroupType, null: true,
description: 'Group that a User is a member of'
description: 'Group that a User is a member of.'
def group
Gitlab::Graphql::Loaders::BatchModelLoader.new(Group, object.source_id).find
......
app/graphql/types/group_type.rb
View file @ fab4f707
......@@ -9,91 +9,91 @@ module Types
expose_permissions Types::PermissionTypes::Group
field :web_url, GraphQL::STRING_TYPE, null: false,
description: 'Web URL of the group'
description: 'Web URL of the group.'
field :avatar_url, GraphQL::STRING_TYPE, null: true,
description: 'Avatar URL of the group'
description: 'Avatar URL of the group.'
field :custom_emoji, Types::CustomEmojiType.connection_type, null: true,
description: 'Custom emoji within this namespace',
description: 'Custom emoji within this namespace.',
feature_flag: :custom_emoji
field :share_with_group_lock, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if sharing a project with another group within this group is prevented'
description: 'Indicates if sharing a project with another group within this group is prevented.'
field :project_creation_level, GraphQL::STRING_TYPE, null: true, method: :project_creation_level_str,
description: 'The permission level required to create projects in the group'
description: 'The permission level required to create projects in the group.'
field :subgroup_creation_level, GraphQL::STRING_TYPE, null: true, method: :subgroup_creation_level_str,
description: 'The permission level required to create subgroups within the group'
description: 'The permission level required to create subgroups within the group.'
field :require_two_factor_authentication, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if all users in this group are required to set up two-factor authentication'
description: 'Indicates if all users in this group are required to set up two-factor authentication.'
field :two_factor_grace_period, GraphQL::INT_TYPE, null: true,
description: 'Time before two-factor authentication is enforced'
description: 'Time before two-factor authentication is enforced.'
field :auto_devops_enabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates whether Auto DevOps is enabled for all projects within this group'
description: 'Indicates whether Auto DevOps is enabled for all projects within this group.'
field :emails_disabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if a group has email notifications disabled'
description: 'Indicates if a group has email notifications disabled.'
field :mentions_disabled, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if a group is disabled from getting mentioned'
description: 'Indicates if a group is disabled from getting mentioned.'
field :parent, GroupType, null: true,
description: 'Parent group'
description: 'Parent group.'
field :issues,
Types::IssueType.connection_type,
null: true,
description: 'Issues for projects in this group',
description: 'Issues for projects in this group.',
resolver: Resolvers::GroupIssuesResolver
field :merge_requests,
Types::MergeRequestType.connection_type,
null: true,
description: 'Merge requests for projects in this group',
description: 'Merge requests for projects in this group.',
resolver: Resolvers::GroupMergeRequestsResolver
field :milestones, Types::MilestoneType.connection_type, null: true,
description: 'Milestones of the group',
description: 'Milestones of the group.',
resolver: Resolvers::GroupMilestonesResolver
field :boards,
Types::BoardType.connection_type,
null: true,
description: 'Boards of the group',
description: 'Boards of the group.',
max_page_size: 2000,
resolver: Resolvers::BoardsResolver
field :board,
Types::BoardType,
null: true,
description: 'A single board of the group',
description: 'A single board of the group.',
resolver: Resolvers::BoardResolver
field :label,
Types::LabelType,
null: true,
description: 'A label available on this group' do
description: 'A label available on this group.' do
argument :title, GraphQL::STRING_TYPE,
required: true,
description: 'Title of the label'
description: 'Title of the label.'
end
field :group_members,
description: 'A membership of a user within this group',
description: 'A membership of a user within this group.',
resolver: Resolvers::GroupMembersResolver
field :container_repositories,
Types::ContainerRepositoryType.connection_type,
null: true,
description: 'Container repositories of the group',
description: 'Container repositories of the group.',
resolver: Resolvers::ContainerRepositoriesResolver,
authorize: :read_container_image
field :container_repositories_count, GraphQL::INT_TYPE, null: false,
description: 'Number of container repositories in the group'
description: 'Number of container repositories in the group.'
def label(title:)
BatchLoader::GraphQL.for(title).batch(key: group) do |titles, loader, args|
......@@ -107,10 +107,10 @@ module Types
field :labels,
Types::LabelType.connection_type,
null: true,
description: 'Labels available on this group' do
description: 'Labels available on this group.' do
argument :search_term, GraphQL::STRING_TYPE,
required: false,
description: 'A search term to find labels with'
description: 'A search term to find labels with.'
end
def labels(search_term: nil)
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ fab4f707
......@@ -3,12 +3,12 @@ Represents the access level of a relationship between a User and object that it
"""
type AccessLevel {
"""
Integer representation of access level
Integer representation of access level.
"""
integerValue: Int
"""
String representation of access level
String representation of access level.
"""
stringValue: AccessLevelEnum
}
......@@ -40,7 +40,7 @@ input AddAwardEmojiInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -180,7 +180,7 @@ Describes an alert from the project's Alert Management
"""
type AlertManagementAlert implements Noteable {
"""
Assignees of the alert
Assignees of the alert.
"""
assignees(
"""
......@@ -205,22 +205,22 @@ type AlertManagementAlert implements Noteable {
): UserConnection
"""
Timestamp the alert was created
Timestamp the alert was created.
"""
createdAt: Time
"""
Description of the alert
Description of the alert.
"""
description: String
"""
Alert details
Alert details.
"""
details: JSON
"""
The URL of the alert detail page
The URL of the alert detail page.
"""
detailsUrl: String!
......@@ -250,42 +250,42 @@ type AlertManagementAlert implements Noteable {
): DiscussionConnection!
"""
Timestamp the alert ended
Timestamp the alert ended.
"""
endedAt: Time
"""
Environment for the alert
Environment for the alert.
"""
environment: Environment
"""
Number of events of this alert
Number of events of this alert.
"""
eventCount: Int
"""
List of hosts the alert came from
List of hosts the alert came from.
"""
hosts: [String!]
"""
Internal ID of the alert
Internal ID of the alert.
"""
iid: ID!
"""
Internal ID of the GitLab issue attached to the alert
Internal ID of the GitLab issue attached to the alert.
"""
issueIid: ID
"""
URL for metrics embed for the alert
URL for metrics embed for the alert.
"""
metricsDashboardUrl: String
"""
Monitoring tool the alert came from
Monitoring tool the alert came from.
"""
monitoringTool: String
......@@ -315,42 +315,42 @@ type AlertManagementAlert implements Noteable {
): NoteConnection!
"""
The alert condition for Prometheus
The alert condition for Prometheus.
"""
prometheusAlert: PrometheusAlert
"""
Runbook for the alert as defined in alert details
Runbook for the alert as defined in alert details.
"""
runbook: String
"""
Service the alert came from
Service the alert came from.
"""
service: String
"""
Severity of the alert
Severity of the alert.
"""
severity: AlertManagementSeverity
"""
Timestamp the alert was raised
Timestamp the alert was raised.
"""
startedAt: Time
"""
Status of the alert
Status of the alert.
"""
status: AlertManagementStatus
"""
Title of the alert
Title of the alert.
"""
title: String
"""
Todos of the current user for the alert
Todos of the current user for the alert.
"""
todos(
"""
......@@ -405,7 +405,7 @@ type AlertManagementAlert implements Noteable {
): TodoConnection
"""
Timestamp the alert was last updated
Timestamp the alert was last updated.
"""
updatedAt: Time
}
......@@ -570,7 +570,7 @@ type AlertManagementAlertStatusCountsType {
acknowledged: Int
"""
Total number of alerts for the project
Total number of alerts for the project.
"""
all: Int
......@@ -580,7 +580,7 @@ type AlertManagementAlertStatusCountsType {
ignored: Int
"""
Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project
Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project.
"""
open: Int
......@@ -615,37 +615,37 @@ An endpoint and credentials used to accept alerts for a project
"""
type AlertManagementHttpIntegration implements AlertManagementIntegration {
"""
Whether the endpoint is currently accepting alerts
Whether the endpoint is currently accepting alerts.
"""
active: Boolean
"""
URL at which Prometheus metrics can be queried to populate the metrics dashboard
URL at which Prometheus metrics can be queried to populate the metrics dashboard.
"""
apiUrl: String
"""
ID of the integration
ID of the integration.
"""
id: ID!
"""
Name of the integration
Name of the integration.
"""
name: String
"""
Token used to authenticate alert notification requests
Token used to authenticate alert notification requests.
"""
token: String
"""
Type of integration
Type of integration.
"""
type: AlertManagementIntegrationType!
"""
Endpoint which accepts alert notifications
Endpoint which accepts alert notifications.
"""
url: String
}
......@@ -657,37 +657,37 @@ scalar AlertManagementHttpIntegrationID
interface AlertManagementIntegration {
"""
Whether the endpoint is currently accepting alerts
Whether the endpoint is currently accepting alerts.
"""
active: Boolean
"""
URL at which Prometheus metrics can be queried to populate the metrics dashboard
URL at which Prometheus metrics can be queried to populate the metrics dashboard.
"""
apiUrl: String
"""
ID of the integration
ID of the integration.
"""
id: ID!
"""
Name of the integration
Name of the integration.
"""
name: String
"""
Token used to authenticate alert notification requests
Token used to authenticate alert notification requests.
"""
token: String
"""
Type of integration
Type of integration.
"""
type: AlertManagementIntegrationType!
"""
Endpoint which accepts alert notifications
Endpoint which accepts alert notifications.
"""
url: String
}
......@@ -847,37 +847,37 @@ An endpoint and credentials used to accept Prometheus alerts for a project
"""
type AlertManagementPrometheusIntegration implements AlertManagementIntegration {
"""
Whether the endpoint is currently accepting alerts
Whether the endpoint is currently accepting alerts.
"""
active: Boolean
"""
URL at which Prometheus metrics can be queried to populate the metrics dashboard
URL at which Prometheus metrics can be queried to populate the metrics dashboard.
"""
apiUrl: String
"""
ID of the integration
ID of the integration.
"""
id: ID!
"""
Name of the integration
Name of the integration.
"""
name: String
"""
Token used to authenticate alert notification requests
Token used to authenticate alert notification requests.
"""
token: String
"""
Type of integration
Type of integration.
"""
type: AlertManagementIntegrationType!
"""
Endpoint which accepts alert notifications
Endpoint which accepts alert notifications.
"""
url: String
}
......@@ -1077,32 +1077,32 @@ An emoji awarded by a user
"""
type AwardEmoji {
"""
The emoji description
The emoji description.
"""
description: String!
"""
The emoji as an icon
The emoji as an icon.
"""
emoji: String!
"""
The emoji name
The emoji name.
"""
name: String!
"""
The emoji in unicode
The emoji in unicode.
"""
unicode: String!
"""
The unicode version for this emoji
The unicode version for this emoji.
"""
unicodeVersion: String!
"""
The user who awarded the emoji
The user who awarded the emoji.
"""
user: User!
}
......@@ -1122,7 +1122,7 @@ input AwardEmojiAddInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -1162,7 +1162,7 @@ input AwardEmojiRemoveInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -1202,7 +1202,7 @@ input AwardEmojiToggleInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -1391,17 +1391,17 @@ type Board {
): BoardEpicConnection
"""
Whether or not backlog list is hidden
Whether or not backlog list is hidden.
"""
hideBacklogList: Boolean
"""
Whether or not closed list is hidden
Whether or not closed list is hidden.
"""
hideClosedList: Boolean
"""
ID (global ID) of the board
ID (global ID) of the board.
"""
id: ID!
......@@ -1436,7 +1436,7 @@ type Board {
): LabelConnection
"""
Lists of the board
Lists of the board.
"""
lists(
"""
......@@ -1476,7 +1476,7 @@ type Board {
milestone: Milestone
"""
Name of the board
Name of the board.
"""
name: String
......@@ -1654,7 +1654,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
createdAt: Time
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -1678,7 +1678,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -2036,12 +2036,12 @@ scalar BoardID
input BoardIssueInput {
"""
Filter by assignee username
Filter by assignee username.
"""
assigneeUsername: [String]
"""
Filter by author username
Filter by author username.
"""
authorUsername: String
......@@ -2066,32 +2066,32 @@ input BoardIssueInput {
iterationWildcardId: IterationWildcardId
"""
Filter by label name
Filter by label name.
"""
labelName: [String]
"""
Filter by milestone title
Filter by milestone title.
"""
milestoneTitle: String
"""
Filter by reaction emoji
Filter by reaction emoji.
"""
myReactionEmoji: String
"""
List of negated params. Warning: this argument is experimental and a subject to change in future
List of negated params. Warning: this argument is experimental and a subject to change in future.
"""
not: NegatedBoardIssueInput
"""
Filter by release tag
Filter by release tag.
"""
releaseTag: String
"""
Search query for issue title or description
Search query for issue title or description.
"""
search: String
......@@ -2111,17 +2111,17 @@ type BoardList {
assignee: User
"""
Indicates if list is collapsed for this user
Indicates if list is collapsed for this user.
"""
collapsed: Boolean
"""
ID (global ID) of the list
ID (global ID) of the list.
"""
id: ID!
"""
Board issues
Board issues.
"""
issues(
"""
......@@ -2151,7 +2151,7 @@ type BoardList {
): IssueConnection
"""
Count of issues in the list
Count of issues in the list.
"""
issuesCount: Int
......@@ -2161,7 +2161,7 @@ type BoardList {
iteration: Iteration
"""
Label of the list
Label of the list.
"""
label: Label
......@@ -2171,7 +2171,7 @@ type BoardList {
limitMetric: ListLimitMetric
"""
Type of the list
Type of the list.
"""
listType: String!
......@@ -2191,12 +2191,12 @@ type BoardList {
milestone: Milestone
"""
Position of list within the board
Position of list within the board.
"""
position: Int
"""
Title of the list
Title of the list.
"""
title: String!
......@@ -2363,12 +2363,12 @@ scalar BoardsEpicListID
type Branch {
"""
Commit for the branch
Commit for the branch.
"""
commit: Commit
"""
Name of the branch
Name of the branch.
"""
name: String!
}
......@@ -2482,17 +2482,17 @@ type CiCdSettingsUpdatePayload {
type CiConfig {
"""
Linting errors
Linting errors.
"""
errors: [String!]
"""
Merged CI config YAML
Merged CI config YAML.
"""
mergedYaml: String
"""
Stages of the pipeline
Stages of the pipeline.
"""
stages(
"""
......@@ -2517,14 +2517,14 @@ type CiConfig {
): CiConfigStageConnection
"""
Status of linting, can be either valid or invalid
Status of linting, can be either valid or invalid.
"""
status: CiConfigStatus
}
type CiConfigGroup {
"""
Jobs in group
Jobs in group.
"""
jobs(
"""
......@@ -2549,12 +2549,12 @@ type CiConfigGroup {
): CiConfigJobConnection
"""
Name of the job group
Name of the job group.
"""
name: String
"""
Size of the job group
Size of the job group.
"""
size: Int
}
......@@ -2725,7 +2725,7 @@ type CiConfigJobRestriction {
type CiConfigNeed {
"""
Name of the need
Name of the need.
"""
name: String
}
......@@ -2767,7 +2767,7 @@ type CiConfigNeedEdge {
type CiConfigStage {
"""
Groups of jobs for the stage
Groups of jobs for the stage.
"""
groups(
"""
......@@ -2792,7 +2792,7 @@ type CiConfigStage {
): CiConfigGroupConnection
"""
Name of the stage
Name of the stage.
"""
name: String
}
......@@ -2849,12 +2849,12 @@ enum CiConfigStatus {
type CiGroup {
"""
Detailed status of the group
Detailed status of the group.
"""
detailedStatus: DetailedStatus
"""
Jobs in group
Jobs in group.
"""
jobs(
"""
......@@ -2879,12 +2879,12 @@ type CiGroup {
): CiJobConnection
"""
Name of the job group
Name of the job group.
"""
name: String
"""
Size of the group
Size of the group.
"""
size: Int
}
......@@ -2926,7 +2926,7 @@ type CiGroupEdge {
type CiJob {
"""
Artifacts generated by the job
Artifacts generated by the job.
"""
artifacts(
"""
......@@ -2951,17 +2951,17 @@ type CiJob {
): CiJobArtifactConnection
"""
Detailed status of the job
Detailed status of the job.
"""
detailedStatus: DetailedStatus
"""
Name of the job
Name of the job.
"""
name: String
"""
References to builds that must complete before the jobs run
References to builds that must complete before the jobs run.
"""
needs(
"""
......@@ -2986,24 +2986,24 @@ type CiJob {
): CiBuildNeedConnection
"""
Pipeline the job belongs to
Pipeline the job belongs to.
"""
pipeline: Pipeline
"""
Schedule for the build
Schedule for the build.
"""
scheduledAt: Time
}
type CiJobArtifact {
"""
URL for downloading the artifact's file
URL for downloading the artifact's file.
"""
downloadPath: String
"""
File type of the artifact
File type of the artifact.
"""
fileType: JobArtifactFileType
}
......@@ -3085,12 +3085,12 @@ scalar CiPipelineID
type CiStage {
"""
Detailed status of the stage
Detailed status of the stage.
"""
detailedStatus: DetailedStatus
"""
Group of jobs for the stage
Group of jobs for the stage.
"""
groups(
"""
......@@ -3115,7 +3115,7 @@ type CiStage {
): CiGroupConnection
"""
Name of the stage
Name of the stage.
"""
name: String
}
......@@ -3212,7 +3212,7 @@ The connection type for ClusterAgent.
"""
type ClusterAgentConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -3299,7 +3299,7 @@ The connection type for ClusterAgentToken.
"""
type ClusterAgentTokenConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -3501,27 +3501,27 @@ type CodeCoverageSummary {
type Commit {
"""
Author of the commit
Author of the commit.
"""
author: User
"""
Commit authors gravatar
Commit authors gravatar.
"""
authorGravatar: String
"""
Commit authors name
Commit authors name.
"""
authorName: String
"""
Timestamp of when the commit was authored
Timestamp of when the commit was authored.
"""
authoredDate: Time
"""
Description of the commit message
Description of the commit message.
"""
description: String
......@@ -3531,17 +3531,17 @@ type Commit {
descriptionHtml: String
"""
ID (global ID) of the commit
ID (global ID) of the commit.
"""
id: ID!
"""
Raw commit message
Raw commit message.
"""
message: String
"""
Pipelines of the commit ordered latest first
Pipelines of the commit ordered latest first.
"""
pipelines(
"""
......@@ -3581,22 +3581,22 @@ type Commit {
): PipelineConnection
"""
SHA1 ID of the commit
SHA1 ID of the commit.
"""
sha: String!
"""
Short SHA1 ID of the commit
Short SHA1 ID of the commit.
"""
shortId: String!
"""
Rendered HTML of the commit signature
Rendered HTML of the commit signature.
"""
signatureHtml: String
"""
Title of the commit message
Title of the commit message.
"""
title: String
......@@ -3606,49 +3606,49 @@ type Commit {
titleHtml: String
"""
Web path of the commit
Web path of the commit.
"""
webPath: String!
"""
Web URL of the commit
Web URL of the commit.
"""
webUrl: String!
}
input CommitAction {
"""
The action to perform, create, delete, move, update, chmod
The action to perform, create, delete, move, update, chmod.
"""
action: CommitActionMode!
"""
Content of the file
Content of the file.
"""
content: String
"""
Encoding of the file. Default is text
Encoding of the file. Default is text.
"""
encoding: CommitEncoding
"""
Enables/disables the execute flag on the file
Enables/disables the execute flag on the file.
"""
executeFilemode: Boolean
"""
Full path to the file
Full path to the file.
"""
filePath: String!
"""
Last known file commit ID
Last known file commit ID.
"""
lastCommitId: String
"""
Original full path to the file being moved
Original full path to the file being moved.
"""
previousPath: String
}
......@@ -3723,7 +3723,7 @@ input CommitCreateInput {
clientMutationId: String
"""
Raw commit message
Raw commit message.
"""
message: String!
......@@ -3917,47 +3917,47 @@ A tag expiration policy designed to keep only the images that matter most
"""
type ContainerExpirationPolicy {
"""
This container expiration policy schedule
This container expiration policy schedule.
"""
cadence: ContainerExpirationPolicyCadenceEnum!
"""
Timestamp of when the container expiration policy was created
Timestamp of when the container expiration policy was created.
"""
createdAt: Time!
"""
Indicates whether this container expiration policy is enabled
Indicates whether this container expiration policy is enabled.
"""
enabled: Boolean!
"""
Number of tags to retain
Number of tags to retain.
"""
keepN: ContainerExpirationPolicyKeepEnum
"""
Tags with names matching this regex pattern will expire
Tags with names matching this regex pattern will expire.
"""
nameRegex: UntrustedRegexp
"""
Tags with names matching this regex pattern will be preserved
Tags with names matching this regex pattern will be preserved.
"""
nameRegexKeep: UntrustedRegexp
"""
Next time that this container expiration policy will get executed
Next time that this container expiration policy will get executed.
"""
nextRunAt: Time
"""
Tags older that this will expire
Tags older that this will expire.
"""
olderThan: ContainerExpirationPolicyOlderThanEnum
"""
Timestamp of when the container expiration policy was updated
Timestamp of when the container expiration policy was updated.
"""
updatedAt: Time!
}
......@@ -4088,7 +4088,7 @@ type ContainerRepository {
path: String!
"""
Project of the container registry
Project of the container registry.
"""
project: Project!
......@@ -4198,7 +4198,7 @@ type ContainerRepositoryDetails {
path: String!
"""
Project of the container registry
Project of the container registry.
"""
project: Project!
......@@ -4208,7 +4208,7 @@ type ContainerRepositoryDetails {
status: ContainerRepositoryStatus
"""
Tags of the container repository
Tags of the container repository.
"""
tags(
"""
......@@ -4493,12 +4493,12 @@ input CreateBoardInput {
groupPath: ID
"""
Whether or not backlog list is hidden
Whether or not backlog list is hidden.
"""
hideBacklogList: Boolean
"""
Whether or not closed list is hidden
Whether or not closed list is hidden.
"""
hideClosedList: Boolean
......@@ -5335,7 +5335,7 @@ type CreateTestCasePayload {
interface CurrentUserTodos {
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -5359,7 +5359,7 @@ interface CurrentUserTodos {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -5370,22 +5370,22 @@ A custom emoji uploaded by user
"""
type CustomEmoji {
"""
Whether the emoji is an external link
Whether the emoji is an external link.
"""
external: Boolean!
"""
The ID of the emoji
The ID of the emoji.
"""
id: CustomEmojiID!
"""
The name of the emoji
The name of the emoji.
"""
name: String!
"""
The link to file of the emoji
The link to file of the emoji.
"""
url: String!
}
......@@ -6382,17 +6382,17 @@ The response from the AdminSidekiqQueuesDeleteJobs mutation
"""
type DeleteJobsResponse {
"""
Whether or not the entire queue was processed in time; if not, retrying the same request is safe
Whether or not the entire queue was processed in time; if not, retrying the same request is safe.
"""
completed: Boolean
"""
The number of matching jobs deleted
The number of matching jobs deleted.
"""
deletedJobs: Int
"""
The queue size after processing
The queue size after processing.
"""
queueSize: Int
}
......@@ -6402,7 +6402,7 @@ A single design
"""
type Design implements CurrentUserTodos & DesignFields & Noteable {
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -6426,13 +6426,13 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
"""
The diff refs for this design
The diff refs for this design.
"""
diffRefs: DiffRefs!
......@@ -6462,27 +6462,27 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
): DiscussionConnection!
"""
How this design was changed in the current version
How this design was changed in the current version.
"""
event: DesignVersionEvent!
"""
The filename of the design
The filename of the design.
"""
filename: String!
"""
The full path to the design file
The full path to the design file.
"""
fullPath: String!
"""
The ID of this design
The ID of this design.
"""
id: ID!
"""
The URL of the full-sized image
The URL of the full-sized image.
"""
image: String!
......@@ -6492,7 +6492,7 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
imageV432x230: String
"""
The issue the design belongs to
The issue the design belongs to.
"""
issue: Issue!
......@@ -6522,17 +6522,17 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
): NoteConnection!
"""
The total count of user-created notes for this design
The total count of user-created notes for this design.
"""
notesCount: Int!
"""
The project the design belongs to
The project the design belongs to.
"""
project: Project!
"""
All versions related to this design ordered newest first
All versions related to this design ordered newest first.
"""
versions(
"""
......@@ -6572,37 +6572,37 @@ A design pinned to a specific version. The image field reflects the design as of
"""
type DesignAtVersion implements DesignFields {
"""
The underlying design
The underlying design.
"""
design: Design!
"""
The diff refs for this design
The diff refs for this design.
"""
diffRefs: DiffRefs!
"""
How this design was changed in the current version
How this design was changed in the current version.
"""
event: DesignVersionEvent!
"""
The filename of the design
The filename of the design.
"""
filename: String!
"""
The full path to the design file
The full path to the design file.
"""
fullPath: String!
"""
The ID of this design
The ID of this design.
"""
id: ID!
"""
The URL of the full-sized image
The URL of the full-sized image.
"""
image: String!
......@@ -6612,22 +6612,22 @@ type DesignAtVersion implements DesignFields {
imageV432x230: String
"""
The issue the design belongs to
The issue the design belongs to.
"""
issue: Issue!
"""
The total count of user-created notes for this design
The total count of user-created notes for this design.
"""
notesCount: Int!
"""
The project the design belongs to
The project the design belongs to.
"""
project: Project!
"""
The version this design-at-versions is pinned to
The version this design-at-versions is pinned to.
"""
version: DesignVersion!
}
......@@ -6672,12 +6672,12 @@ A collection of designs
"""
type DesignCollection {
"""
Copy state of the design collection
Copy state of the design collection.
"""
copyState: DesignCollectionCopyState
"""
Find a specific design
Find a specific design.
"""
design(
"""
......@@ -6692,7 +6692,7 @@ type DesignCollection {
): Design
"""
Find a design as of a version
Find a design as of a version.
"""
designAtVersion(
"""
......@@ -6702,7 +6702,7 @@ type DesignCollection {
): DesignAtVersion
"""
All designs for the design collection
All designs for the design collection.
"""
designs(
"""
......@@ -6743,17 +6743,17 @@ type DesignCollection {
): DesignConnection!
"""
Issue associated with the design collection
Issue associated with the design collection.
"""
issue: Issue!
"""
Project associated with the design collection
Project associated with the design collection.
"""
project: Project!
"""
A specific version
A specific version.
"""
version(
"""
......@@ -6768,7 +6768,7 @@ type DesignCollection {
): DesignVersion
"""
All versions related to all designs, ordered newest first
All versions related to all designs, ordered newest first.
"""
versions(
"""
......@@ -6860,32 +6860,32 @@ type DesignEdge {
interface DesignFields {
"""
The diff refs for this design
The diff refs for this design.
"""
diffRefs: DiffRefs!
"""
How this design was changed in the current version
How this design was changed in the current version.
"""
event: DesignVersionEvent!
"""
The filename of the design
The filename of the design.
"""
filename: String!
"""
The full path to the design file
The full path to the design file.
"""
fullPath: String!
"""
The ID of this design
The ID of this design.
"""
id: ID!
"""
The URL of the full-sized image
The URL of the full-sized image.
"""
image: String!
......@@ -6895,24 +6895,24 @@ interface DesignFields {
imageV432x230: String
"""
The issue the design belongs to
The issue the design belongs to.
"""
issue: Issue!
"""
The total count of user-created notes for this design
The total count of user-created notes for this design.
"""
notesCount: Int!
"""
The project the design belongs to
The project the design belongs to.
"""
project: Project!
}
type DesignManagement {
"""
Find a design as of a version
Find a design as of a version.
"""
designAtVersion(
"""
......@@ -6922,7 +6922,7 @@ type DesignManagement {
): DesignAtVersion
"""
Find a version
Find a version.
"""
version(
"""
......@@ -7092,7 +7092,7 @@ A specific version in which designs were added, modified or deleted
"""
type DesignVersion {
"""
A particular design as of this version, provided it is visible at this version
A particular design as of this version, provided it is visible at this version.
"""
designAtVersion(
"""
......@@ -7112,7 +7112,7 @@ type DesignVersion {
): DesignAtVersion!
"""
All designs that were changed in the version
All designs that were changed in the version.
"""
designs(
"""
......@@ -7137,7 +7137,7 @@ type DesignVersion {
): DesignConnection!
"""
All designs that are visible at this version, as of this version
All designs that are visible at this version, as of this version.
"""
designsAtVersion(
"""
......@@ -7172,12 +7172,12 @@ type DesignVersion {
): DesignAtVersionConnection!
"""
ID of the design version
ID of the design version.
"""
id: ID!
"""
SHA of the design version
SHA of the design version.
"""
sha: ID!
}
......@@ -7489,47 +7489,47 @@ type DestroySnippetPayload {
type DetailedStatus {
"""
Action information for the status. This includes method, button title, icon, path, and title
Action information for the status. This includes method, button title, icon, path, and title.
"""
action: StatusAction
"""
Path of the details for the status
Path of the details for the status.
"""
detailsPath: String
"""
Favicon of the status
Favicon of the status.
"""
favicon: String
"""
Group of the status
Group of the status.
"""
group: String
"""
Indicates if the status has further details
Indicates if the status has further details.
"""
hasDetails: Boolean
"""
Icon of the status
Icon of the status.
"""
icon: String
"""
Label of the status
Label of the status.
"""
label: String
"""
Text of the status
Text of the status.
"""
text: String
"""
Tooltip associated with the status
Tooltip associated with the status.
"""
tooltip: String
}
......@@ -7651,12 +7651,12 @@ type DevopsAdoptionSnapshot {
input DiffImagePositionInput {
"""
Merge base of the branch the comment was made on
Merge base of the branch the comment was made on.
"""
baseSha: String
"""
SHA of the HEAD at the time the comment was made
SHA of the HEAD at the time the comment was made.
"""
headSha: String!
......@@ -7672,7 +7672,7 @@ input DiffImagePositionInput {
paths: DiffPathsInput!
"""
SHA of the branch being compared against
SHA of the branch being compared against.
"""
startSha: String!
......@@ -7699,12 +7699,12 @@ scalar DiffNoteID
input DiffPathsInput {
"""
The path of the file on the head sha
The path of the file on the head sha.
"""
newPath: String
"""
The path of the file on the start sha
The path of the file on the start sha.
"""
oldPath: String
}
......@@ -7768,12 +7768,12 @@ type DiffPosition {
input DiffPositionInput {
"""
Merge base of the branch the comment was made on
Merge base of the branch the comment was made on.
"""
baseSha: String
"""
SHA of the HEAD at the time the comment was made
SHA of the HEAD at the time the comment was made.
"""
headSha: String!
......@@ -7794,7 +7794,7 @@ input DiffPositionInput {
paths: DiffPathsInput!
"""
SHA of the branch being compared against
SHA of the branch being compared against.
"""
startSha: String!
}
......@@ -7809,17 +7809,17 @@ enum DiffPositionType {
type DiffRefs {
"""
Merge base of the branch the comment was made on
Merge base of the branch the comment was made on.
"""
baseSha: String
"""
SHA of the HEAD at the time the comment was made
SHA of the HEAD at the time the comment was made.
"""
headSha: String!
"""
SHA of the branch being compared against
SHA of the branch being compared against.
"""
startSha: String!
}
......@@ -7829,17 +7829,17 @@ Changes to a single file
"""
type DiffStats {
"""
Number of lines added to this file
Number of lines added to this file.
"""
additions: Int!
"""
Number of lines deleted from this file
Number of lines deleted from this file.
"""
deletions: Int!
"""
File path, relative to repository root
File path, relative to repository root.
"""
path: String!
}
......@@ -7849,22 +7849,22 @@ Aggregated summary of changes
"""
type DiffStatsSummary {
"""
Number of lines added
Number of lines added.
"""
additions: Int!
"""
Number of lines changed
Number of lines changed.
"""
changes: Int!
"""
Number of lines deleted
Number of lines deleted.
"""
deletions: Int!
"""
Number of files changed
Number of files changed.
"""
fileCount: Int!
}
......@@ -8102,17 +8102,17 @@ Describes where code is deployed for a project
"""
type Environment {
"""
ID of the environment
ID of the environment.
"""
id: ID!
"""
The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned
The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.
"""
latestOpenedMostSevereAlert: AlertManagementAlert
"""
Metrics dashboard schema for the environment
Metrics dashboard schema for the environment.
"""
metricsDashboard(
"""
......@@ -8122,7 +8122,7 @@ type Environment {
): MetricsDashboard
"""
Human-readable name of the environment
Human-readable name of the environment.
"""
name: String!
......@@ -8132,7 +8132,7 @@ type Environment {
path: String!
"""
State of the environment, for example: available/stopped
State of the environment, for example: available/stopped.
"""
state: String!
}
......@@ -8335,7 +8335,7 @@ type Epic implements CurrentUserTodos & Noteable {
createdAt: Time
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -8359,7 +8359,7 @@ type Epic implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -8965,7 +8965,7 @@ type EpicIssue implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -8989,7 +8989,7 @@ type EpicIssue implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -9315,7 +9315,7 @@ The connection type for EpicIssue.
"""
type EpicIssueConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -9978,27 +9978,27 @@ scalar GitlabErrorTrackingDetailedErrorID
type GrafanaIntegration {
"""
Timestamp of the issue's creation
Timestamp of the issue's creation.
"""
createdAt: Time!
"""
Indicates whether Grafana integration is enabled
Indicates whether Grafana integration is enabled.
"""
enabled: Boolean!
"""
URL for the Grafana host for the Grafana integration
URL for the Grafana host for the Grafana integration.
"""
grafanaUrl: String!
"""
Internal ID of the Grafana integration
Internal ID of the Grafana integration.
"""
id: ID!
"""
Timestamp of the issue's last activity
Timestamp of the issue's last activity.
"""
updatedAt: Time!
}
......@@ -10015,17 +10015,17 @@ type Group {
additionalPurchasedStorageSize: Float
"""
Indicates whether Auto DevOps is enabled for all projects within this group
Indicates whether Auto DevOps is enabled for all projects within this group.
"""
autoDevopsEnabled: Boolean
"""
Avatar URL of the group
Avatar URL of the group.
"""
avatarUrl: String
"""
A single board of the group
A single board of the group.
"""
board(
"""
......@@ -10035,7 +10035,7 @@ type Group {
): Board
"""
Boards of the group
Boards of the group.
"""
boards(
"""
......@@ -10126,7 +10126,7 @@ type Group {
): ComplianceFrameworkConnection
"""
Container repositories of the group
Container repositories of the group.
"""
containerRepositories(
"""
......@@ -10156,7 +10156,7 @@ type Group {
): ContainerRepositoryConnection
"""
Number of container repositories in the group
Number of container repositories in the group.
"""
containerRepositoriesCount: Int!
......@@ -10166,7 +10166,7 @@ type Group {
containsLockedProjects: Boolean!
"""
Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled.
Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled.
"""
customEmoji(
"""
......@@ -10201,7 +10201,7 @@ type Group {
descriptionHtml: String
"""
Indicates if a group has email notifications disabled
Indicates if a group has email notifications disabled.
"""
emailsDisabled: Boolean
......@@ -10432,7 +10432,7 @@ type Group {
fullPath: ID!
"""
A membership of a user within this group
A membership of a user within this group.
"""
groupMembers(
"""
......@@ -10482,7 +10482,7 @@ type Group {
isTemporaryStorageIncreaseEnabled: Boolean!
"""
Issues for projects in this group
Issues for projects in this group.
"""
issues(
"""
......@@ -10680,17 +10680,17 @@ type Group {
): IterationConnection
"""
A label available on this group
A label available on this group.
"""
label(
"""
Title of the label
Title of the label.
"""
title: String!
): Label
"""
Labels available on this group
Labels available on this group.
"""
labels(
"""
......@@ -10714,7 +10714,7 @@ type Group {
last: Int
"""
A search term to find labels with
A search term to find labels with.
"""
searchTerm: String
): LabelConnection
......@@ -10725,12 +10725,12 @@ type Group {
lfsEnabled: Boolean
"""
Indicates if a group is disabled from getting mentioned
Indicates if a group is disabled from getting mentioned.
"""
mentionsDisabled: Boolean
"""
Merge requests for projects in this group
Merge requests for projects in this group.
"""
mergeRequests(
"""
......@@ -10815,7 +10815,7 @@ type Group {
): MergeRequestConnection
"""
Milestones of the group
Milestones of the group.
"""
milestones(
"""
......@@ -10898,7 +10898,7 @@ type Group {
packageSettings: PackageSettings
"""
Parent group
Parent group.
"""
parent: Group
......@@ -10908,7 +10908,7 @@ type Group {
path: String!
"""
The permission level required to create projects in the group
The permission level required to create projects in the group.
"""
projectCreationLevel: String
......@@ -10968,7 +10968,7 @@ type Group {
requestAccessEnabled: Boolean
"""
Indicates if all users in this group are required to set up two-factor authentication
Indicates if all users in this group are required to set up two-factor authentication.
"""
requireTwoFactorAuthentication: Boolean
......@@ -10978,7 +10978,7 @@ type Group {
rootStorageStatistics: RootStorageStatistics
"""
Indicates if sharing a project with another group within this group is prevented
Indicates if sharing a project with another group within this group is prevented.
"""
shareWithGroupLock: Boolean
......@@ -10993,7 +10993,7 @@ type Group {
storageSizeLimit: Float
"""
The permission level required to create subgroups within the group
The permission level required to create subgroups within the group.
"""
subgroupCreationLevel: String
......@@ -11058,7 +11058,7 @@ type Group {
totalRepositorySizeExcess: Float
"""
Time before two-factor authentication is enforced
Time before two-factor authentication is enforced.
"""
twoFactorGracePeriod: Int
......@@ -11274,7 +11274,7 @@ type Group {
): VulnerabilitySeveritiesCount
"""
Web URL of the group
Web URL of the group.
"""
webUrl: String!
}
......@@ -11309,7 +11309,7 @@ type GroupMember implements MemberInterface {
expiresAt: Time
"""
Group that a User is a member of
Group that a User is a member of.
"""
group: Group
......@@ -11884,17 +11884,17 @@ Represents a recorded measurement (object count) for the Admins
"""
type InstanceStatisticsMeasurement {
"""
Object count
Object count.
"""
count: Int!
"""
The type of objects being measured
The type of objects being measured.
"""
identifier: MeasurementIdentifier!
"""
The time the measurement was recorded
The time the measurement was recorded.
"""
recordedAt: Time
}
......@@ -12041,7 +12041,7 @@ type Issue implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -12065,7 +12065,7 @@ type Issue implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -12381,7 +12381,7 @@ The connection type for Issue.
"""
type IssueConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -13719,7 +13719,7 @@ The connection type for Label.
"""
type LabelConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -14124,7 +14124,7 @@ type MergeRequest implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user
Todos for the current user.
"""
currentUserTodos(
"""
......@@ -14148,7 +14148,7 @@ type MergeRequest implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos
State of the todos.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -14639,7 +14639,7 @@ The connection type for MergeRequest.
"""
type MergeRequestConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -16075,12 +16075,12 @@ enum NamespaceProjectSort {
input NegatedBoardIssueInput {
"""
Filter by assignee username
Filter by assignee username.
"""
assigneeUsername: [String]
"""
Filter by author username
Filter by author username.
"""
authorUsername: String
......@@ -16095,22 +16095,22 @@ input NegatedBoardIssueInput {
iterationTitle: String
"""
Filter by label name
Filter by label name.
"""
labelName: [String]
"""
Filter by milestone title
Filter by milestone title.
"""
milestoneTitle: String
"""
Filter by reaction emoji
Filter by reaction emoji.
"""
myReactionEmoji: String
"""
Filter by release tag
Filter by release tag.
"""
releaseTag: String
......@@ -17221,22 +17221,22 @@ type PageInfo {
type Pipeline {
"""
Indicates if the pipeline is active
Indicates if the pipeline is active.
"""
active: Boolean!
"""
Base SHA of the source branch
Base SHA of the source branch.
"""
beforeSha: String
"""
Specifies if a pipeline can be canceled
Specifies if a pipeline can be canceled.
"""
cancelable: Boolean!
"""
Timestamp of the pipeline's commit
Timestamp of the pipeline's commit.
"""
committedAt: Time
......@@ -17248,22 +17248,22 @@ type Pipeline {
configSource: PipelineConfigSourceEnum
"""
Coverage percentage
Coverage percentage.
"""
coverage: Float
"""
Timestamp of the pipeline's creation
Timestamp of the pipeline's creation.
"""
createdAt: Time!
"""
Detailed status of the pipeline
Detailed status of the pipeline.
"""
detailedStatus: DetailedStatus!
"""
Pipelines this pipeline will trigger
Pipelines this pipeline will trigger.
"""
downstream(
"""
......@@ -17288,27 +17288,27 @@ type Pipeline {
): PipelineConnection
"""
Duration of the pipeline in seconds
Duration of the pipeline in seconds.
"""
duration: Int
"""
Timestamp of the pipeline's completion
Timestamp of the pipeline's completion.
"""
finishedAt: Time
"""
ID of the pipeline
ID of the pipeline.
"""
id: ID!
"""
Internal ID of the pipeline
Internal ID of the pipeline.
"""
iid: String!
"""
Jobs belonging to the pipeline
Jobs belonging to the pipeline.
"""
jobs(
"""
......@@ -17338,17 +17338,17 @@ type Pipeline {
): CiJobConnection
"""
Relative path to the pipeline's page
Relative path to the pipeline's page.
"""
path: String
"""
Project the pipeline belongs to
Project the pipeline belongs to.
"""
project: Project
"""
Specifies if a pipeline can be retried
Specifies if a pipeline can be retried.
"""
retryable: Boolean!
......@@ -17358,17 +17358,17 @@ type Pipeline {
securityReportSummary: SecurityReportSummary
"""
SHA of the pipeline's commit
SHA of the pipeline's commit.
"""
sha: String!
"""
Job where pipeline was triggered from
Job where pipeline was triggered from.
"""
sourceJob: CiJob
"""
Stages of the pipeline
Stages of the pipeline.
"""
stages(
"""
......@@ -17393,7 +17393,7 @@ type Pipeline {
): CiStageConnection
"""
Timestamp when the pipeline was started
Timestamp when the pipeline was started.
"""
startedAt: Time
......@@ -17404,17 +17404,17 @@ type Pipeline {
status: PipelineStatusEnum!
"""
Timestamp of the pipeline's last activity
Timestamp of the pipeline's last activity.
"""
updatedAt: Time!
"""
Pipeline that triggered the pipeline
Pipeline that triggered the pipeline.
"""
upstream: Pipeline
"""
Pipeline user
Pipeline user.
"""
user: User
......@@ -17426,57 +17426,57 @@ type Pipeline {
type PipelineAnalytics {
"""
Labels for the monthly pipeline count
Labels for the monthly pipeline count.
"""
monthPipelinesLabels: [String!]
"""
Total monthly successful pipeline count
Total monthly successful pipeline count.
"""
monthPipelinesSuccessful: [Int!]
"""
Total monthly pipeline count
Total monthly pipeline count.
"""
monthPipelinesTotals: [Int!]
"""
Pipeline times labels
Pipeline times labels.
"""
pipelineTimesLabels: [String!]
"""
Pipeline times
Pipeline times.
"""
pipelineTimesValues: [Int!]
"""
Labels for the weekly pipeline count
Labels for the weekly pipeline count.
"""
weekPipelinesLabels: [String!]
"""
Total weekly successful pipeline count
Total weekly successful pipeline count.
"""
weekPipelinesSuccessful: [Int!]
"""
Total weekly pipeline count
Total weekly pipeline count.
"""
weekPipelinesTotals: [Int!]
"""
Labels for the yearly pipeline count
Labels for the yearly pipeline count.
"""
yearPipelinesLabels: [String!]
"""
Total yearly successful pipeline count
Total yearly successful pipeline count.
"""
yearPipelinesSuccessful: [Int!]
"""
Total yearly pipeline count
Total yearly pipeline count.
"""
yearPipelinesTotals: [Int!]
}
......@@ -17527,7 +17527,7 @@ The connection type for Pipeline.
"""
type PipelineConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -21051,7 +21051,7 @@ The connection type for Release.
"""
type ReleaseConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -21201,22 +21201,22 @@ Evidence for a release
"""
type ReleaseEvidence {
"""
Timestamp when the evidence was collected
Timestamp when the evidence was collected.
"""
collectedAt: Time
"""
URL from where the evidence can be downloaded
URL from where the evidence can be downloaded.
"""
filepath: String
"""
ID of the evidence
ID of the evidence.
"""
id: ID!
"""
SHA1 ID of the evidence hash
SHA1 ID of the evidence hash.
"""
sha: String
}
......@@ -21443,7 +21443,7 @@ input RemoveAwardEmojiInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -21924,12 +21924,12 @@ type RunDASTScanPayload {
type RunnerArchitecture {
"""
Download location for the runner for the platform architecture
Download location for the runner for the platform architecture.
"""
downloadLocation: String!
"""
Name of the runner platform architecture
Name of the runner platform architecture.
"""
name: String!
}
......@@ -21971,7 +21971,7 @@ type RunnerArchitectureEdge {
type RunnerPlatform {
"""
Runner architectures supported for the platform
Runner architectures supported for the platform.
"""
architectures(
"""
......@@ -21996,12 +21996,12 @@ type RunnerPlatform {
): RunnerArchitectureConnection
"""
Human readable name of the runner platform
Human readable name of the runner platform.
"""
humanReadableName: String!
"""
Name slug of the runner platform
Name slug of the runner platform.
"""
name: String!
}
......@@ -22043,12 +22043,12 @@ type RunnerPlatformEdge {
type RunnerSetup {
"""
Instructions for installing the runner on the specified architecture
Instructions for installing the runner on the specified architecture.
"""
installInstructions: String!
"""
Instructions for registering the runner
Instructions for registering the runner.
"""
registerInstructions: String
}
......@@ -22647,142 +22647,142 @@ A Sentry error
"""
type SentryDetailedError {
"""
Count of occurrences
Count of occurrences.
"""
count: Int!
"""
Culprit of the error
Culprit of the error.
"""
culprit: String!
"""
External Base URL of the Sentry Instance
External Base URL of the Sentry Instance.
"""
externalBaseUrl: String!
"""
External URL of the error
External URL of the error.
"""
externalUrl: String!
"""
Commit the error was first seen
Commit the error was first seen.
"""
firstReleaseLastCommit: String
"""
Release short version the error was first seen
Release short version the error was first seen.
"""
firstReleaseShortVersion: String
"""
Release version the error was first seen
Release version the error was first seen.
"""
firstReleaseVersion: String
"""
Timestamp when the error was first seen
Timestamp when the error was first seen.
"""
firstSeen: Time!
"""
Last 24hr stats of the error
Last 24hr stats of the error.
"""
frequency: [SentryErrorFrequency!]!
"""
GitLab commit SHA attributed to the Error based on the release version
GitLab commit SHA attributed to the Error based on the release version.
"""
gitlabCommit: String
"""
Path to the GitLab page for the GitLab commit attributed to the error
Path to the GitLab page for the GitLab commit attributed to the error.
"""
gitlabCommitPath: String
"""
URL of GitLab Issue
URL of GitLab Issue.
"""
gitlabIssuePath: String
"""
ID (global ID) of the error
ID (global ID) of the error.
"""
id: ID!
"""
Commit the error was last seen
Commit the error was last seen.
"""
lastReleaseLastCommit: String
"""
Release short version the error was last seen
Release short version the error was last seen.
"""
lastReleaseShortVersion: String
"""
Release version the error was last seen
Release version the error was last seen.
"""
lastReleaseVersion: String
"""
Timestamp when the error was last seen
Timestamp when the error was last seen.
"""
lastSeen: Time!
"""
Sentry metadata message of the error
Sentry metadata message of the error.
"""
message: String
"""
ID (Sentry ID) of the error
ID (Sentry ID) of the error.
"""
sentryId: String!
"""
ID of the project (Sentry project)
ID of the project (Sentry project).
"""
sentryProjectId: ID!
"""
Name of the project affected by the error
Name of the project affected by the error.
"""
sentryProjectName: String!
"""
Slug of the project affected by the error
Slug of the project affected by the error.
"""
sentryProjectSlug: String!
"""
Short ID (Sentry ID) of the error
Short ID (Sentry ID) of the error.
"""
shortId: String!
"""
Status of the error
Status of the error.
"""
status: SentryErrorStatus!
"""
Tags associated with the Sentry Error
Tags associated with the Sentry Error.
"""
tags: SentryErrorTags!
"""
Title of the error
Title of the error.
"""
title: String!
"""
Type of the error
Type of the error.
"""
type: String!
"""
Count of users affected by the error
Count of users affected by the error.
"""
userCount: Int!
}
......@@ -22792,87 +22792,87 @@ A Sentry error. A simplified version of SentryDetailedError
"""
type SentryError {
"""
Count of occurrences
Count of occurrences.
"""
count: Int!
"""
Culprit of the error
Culprit of the error.
"""
culprit: String!
"""
External URL of the error
External URL of the error.
"""
externalUrl: String!
"""
Timestamp when the error was first seen
Timestamp when the error was first seen.
"""
firstSeen: Time!
"""
Last 24hr stats of the error
Last 24hr stats of the error.
"""
frequency: [SentryErrorFrequency!]!
"""
ID (global ID) of the error
ID (global ID) of the error.
"""
id: ID!
"""
Timestamp when the error was last seen
Timestamp when the error was last seen.
"""
lastSeen: Time!
"""
Sentry metadata message of the error
Sentry metadata message of the error.
"""
message: String
"""
ID (Sentry ID) of the error
ID (Sentry ID) of the error.
"""
sentryId: String!
"""
ID of the project (Sentry project)
ID of the project (Sentry project).
"""
sentryProjectId: ID!
"""
Name of the project affected by the error
Name of the project affected by the error.
"""
sentryProjectName: String!
"""
Slug of the project affected by the error
Slug of the project affected by the error.
"""
sentryProjectSlug: String!
"""
Short ID (Sentry ID) of the error
Short ID (Sentry ID) of the error.
"""
shortId: String!
"""
Status of the error
Status of the error.
"""
status: SentryErrorStatus!
"""
Title of the error
Title of the error.
"""
title: String!
"""
Type of the error
Type of the error.
"""
type: String!
"""
Count of users affected by the error
Count of users affected by the error.
"""
userCount: Int!
}
......@@ -22882,7 +22882,7 @@ An object containing a collection of Sentry errors, and a detailed error
"""
type SentryErrorCollection {
"""
Detailed version of a Sentry error on the project
Detailed version of a Sentry error on the project.
"""
detailedError(
"""
......@@ -22892,7 +22892,7 @@ type SentryErrorCollection {
): SentryDetailedError
"""
Stack Trace of Sentry Error
Stack Trace of Sentry Error.
"""
errorStackTrace(
"""
......@@ -22902,7 +22902,7 @@ type SentryErrorCollection {
): SentryErrorStackTrace
"""
Collection of Sentry Errors
Collection of Sentry Errors.
"""
errors(
"""
......@@ -22937,7 +22937,7 @@ type SentryErrorCollection {
): SentryErrorConnection
"""
External URL for Sentry
External URL for Sentry.
"""
externalUrl: String
}
......@@ -22979,12 +22979,12 @@ type SentryErrorEdge {
type SentryErrorFrequency {
"""
Count of errors received since the previously recorded time
Count of errors received since the previously recorded time.
"""
count: Int!
"""
Time the error frequency stats were recorded
Time the error frequency stats were recorded.
"""
time: Time!
}
......@@ -22994,17 +22994,17 @@ An object containing a stack trace entry for a Sentry error
"""
type SentryErrorStackTrace {
"""
Time the stack trace was received by Sentry
Time the stack trace was received by Sentry.
"""
dateReceived: String!
"""
ID of the Sentry error
ID of the Sentry error.
"""
issueId: String!
"""
Stack trace entries for the Sentry error
Stack trace entries for the Sentry error.
"""
stackTraceEntries: [SentryErrorStackTraceEntry!]!
}
......@@ -23014,12 +23014,12 @@ An object context for a Sentry error stack trace
"""
type SentryErrorStackTraceContext {
"""
Code number of the context
Code number of the context.
"""
code: String!
"""
Line number of the context
Line number of the context.
"""
line: Int!
}
......@@ -23029,27 +23029,27 @@ An object containing a stack trace entry for a Sentry error
"""
type SentryErrorStackTraceEntry {
"""
Function in which the Sentry error occurred
Function in which the Sentry error occurred.
"""
col: String
"""
File in which the Sentry error occurred
File in which the Sentry error occurred.
"""
fileName: String
"""
Function in which the Sentry error occurred
Function in which the Sentry error occurred.
"""
function: String
"""
Function in which the Sentry error occurred
Function in which the Sentry error occurred.
"""
line: String
"""
Context of the Sentry error
Context of the Sentry error.
"""
traceContext: [SentryErrorStackTraceContext!]
}
......@@ -23084,12 +23084,12 @@ State of a Sentry error
"""
type SentryErrorTags {
"""
Severity level of the Sentry Error
Severity level of the Sentry Error.
"""
level: String
"""
Logger of the Sentry Error
Logger of the Sentry Error.
"""
logger: String
}
......@@ -23719,27 +23719,27 @@ enum Sort {
type StatusAction {
"""
Title for the button, for example: Retry this job
Title for the button, for example: Retry this job.
"""
buttonTitle: String
"""
Icon used in the action button
Icon used in the action button.
"""
icon: String
"""
Method for the action, for example: :post
Method for the action, for example: :post.
"""
method: String
"""
Path for the action
Path for the action.
"""
path: String
"""
Title for the action, for example: Retry
Title for the action, for example: Retry.
"""
title: String
}
......@@ -23878,7 +23878,7 @@ The connection type for TerraformState.
"""
type TerraformStateConnection {
"""
Total count of collection
Total count of collection.
"""
count: Int!
......@@ -24669,7 +24669,7 @@ input ToggleAwardEmojiInput {
clientMutationId: String
"""
The emoji name
The emoji name.
"""
name: String!
}
......@@ -24986,12 +24986,12 @@ input UpdateBoardInput {
clientMutationId: String
"""
Whether or not backlog list is hidden
Whether or not backlog list is hidden.
"""
hideBacklogList: Boolean
"""
Whether or not closed list is hidden
Whether or not closed list is hidden.
"""
hideClosedList: Boolean
......@@ -25141,7 +25141,7 @@ Autogenerated input type of UpdateContainerExpirationPolicy
"""
input UpdateContainerExpirationPolicyInput {
"""
This container expiration policy schedule
This container expiration policy schedule.
"""
cadence: ContainerExpirationPolicyCadenceEnum
......@@ -25151,27 +25151,27 @@ input UpdateContainerExpirationPolicyInput {
clientMutationId: String
"""
Indicates whether this container expiration policy is enabled
Indicates whether this container expiration policy is enabled.
"""
enabled: Boolean
"""
Number of tags to retain
Number of tags to retain.
"""
keepN: ContainerExpirationPolicyKeepEnum
"""
Tags with names matching this regex pattern will expire
Tags with names matching this regex pattern will expire.
"""
nameRegex: UntrustedRegexp
"""
Tags with names matching this regex pattern will be preserved
Tags with names matching this regex pattern will be preserved.
"""
nameRegexKeep: UntrustedRegexp
"""
Tags older that this will expire
Tags older that this will expire.
"""
olderThan: ContainerExpirationPolicyOlderThanEnum
......
doc/api/graphql/reference/gitlab_schema.json
View file @ fab4f707
This source diff could not be displayed because it is too large. You can view the blob instead.
doc/api/graphql/reference/index.md
View file @ fab4f707
......@@ -41,8 +41,8 @@ Represents the access level of a relationship between a User and object that it
| Field | Type | Description |
| ----- | ---- | ----------- |
| `integerValue` | Int | Integer representation of access level |
| `stringValue` | AccessLevelEnum | String representation of access level |
| `integerValue` | Int | Integer representation of access level. |
| `stringValue` | AccessLevelEnum | String representation of access level. |
### AddAwardEmojiPayload
......@@ -80,30 +80,30 @@ Describes an alert from the project's Alert Management.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `assignees` | UserConnection | Assignees of the alert |
| `createdAt` | Time | Timestamp the alert was created |
| `description` | String | Description of the alert |
| `details` | JSON | Alert details |
| `detailsUrl` | String! | The URL of the alert detail page |
| `assignees` | UserConnection | Assignees of the alert. |
| `createdAt` | Time | Timestamp the alert was created. |
| `description` | String | Description of the alert. |
| `details` | JSON | Alert details. |
| `detailsUrl` | String! | The URL of the alert detail page. |
| `discussions` | DiscussionConnection! | All discussions on this noteable |
| `endedAt` | Time | Timestamp the alert ended |
| `environment` | Environment | Environment for the alert |
| `eventCount` | Int | Number of events of this alert |
| `hosts` | String! => Array | List of hosts the alert came from |
| `iid` | ID! | Internal ID of the alert |
| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert |
| `metricsDashboardUrl` | String | URL for metrics embed for the alert |
| `monitoringTool` | String | Monitoring tool the alert came from |
| `endedAt` | Time | Timestamp the alert ended. |
| `environment` | Environment | Environment for the alert. |
| `eventCount` | Int | Number of events of this alert. |
| `hosts` | String! => Array | List of hosts the alert came from. |
| `iid` | ID! | Internal ID of the alert. |
| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert. |
| `metricsDashboardUrl` | String | URL for metrics embed for the alert. |
| `monitoringTool` | String | Monitoring tool the alert came from. |
| `notes` | NoteConnection! | All notes on this noteable |
| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus |
| `runbook` | String | Runbook for the alert as defined in alert details |
| `service` | String | Service the alert came from |
| `severity` | AlertManagementSeverity | Severity of the alert |
| `startedAt` | Time | Timestamp the alert was raised |
| `status` | AlertManagementStatus | Status of the alert |
| `title` | String | Title of the alert |
| `todos` | TodoConnection | Todos of the current user for the alert |
| `updatedAt` | Time | Timestamp the alert was last updated |
| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus. |
| `runbook` | String | Runbook for the alert as defined in alert details. |
| `service` | String | Service the alert came from. |
| `severity` | AlertManagementSeverity | Severity of the alert. |
| `startedAt` | Time | Timestamp the alert was raised. |
| `status` | AlertManagementStatus | Status of the alert. |
| `title` | String | Title of the alert. |
| `todos` | TodoConnection | Todos of the current user for the alert. |
| `updatedAt` | Time | Timestamp the alert was last updated. |
### AlertManagementAlertStatusCountsType
......@@ -112,9 +112,9 @@ Represents total number of alerts for the represented categories.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `acknowledged` | Int | Number of alerts with status ACKNOWLEDGED for the project |
| `all` | Int | Total number of alerts for the project |
| `all` | Int | Total number of alerts for the project. |
| `ignored` | Int | Number of alerts with status IGNORED for the project |
| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project |
| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. |
| `resolved` | Int | Number of alerts with status RESOLVED for the project |
| `triggered` | Int | Number of alerts with status TRIGGERED for the project |
......@@ -124,13 +124,13 @@ An endpoint and credentials used to accept alerts for a project.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `active` | Boolean | Whether the endpoint is currently accepting alerts |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard |
| `id` | ID! | ID of the integration |
| `name` | String | Name of the integration |
| `token` | String | Token used to authenticate alert notification requests |
| `type` | AlertManagementIntegrationType! | Type of integration |
| `url` | String | Endpoint which accepts alert notifications |
| `active` | Boolean | Whether the endpoint is currently accepting alerts. |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
| `id` | ID! | ID of the integration. |
| `name` | String | Name of the integration. |
| `token` | String | Token used to authenticate alert notification requests. |
| `type` | AlertManagementIntegrationType! | Type of integration. |
| `url` | String | Endpoint which accepts alert notifications. |
### AlertManagementPrometheusIntegration
......@@ -138,13 +138,13 @@ An endpoint and credentials used to accept Prometheus alerts for a project.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `active` | Boolean | Whether the endpoint is currently accepting alerts |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard |
| `id` | ID! | ID of the integration |
| `name` | String | Name of the integration |
| `token` | String | Token used to authenticate alert notification requests |
| `type` | AlertManagementIntegrationType! | Type of integration |
| `url` | String | Endpoint which accepts alert notifications |
| `active` | Boolean | Whether the endpoint is currently accepting alerts. |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
| `id` | ID! | ID of the integration. |
| `name` | String | Name of the integration. |
| `token` | String | Token used to authenticate alert notification requests. |
| `type` | AlertManagementIntegrationType! | Type of integration. |
| `url` | String | Endpoint which accepts alert notifications. |
### AlertSetAssigneesPayload
......@@ -176,12 +176,12 @@ An emoji awarded by a user.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `description` | String! | The emoji description |
| `emoji` | String! | The emoji as an icon |
| `name` | String! | The emoji name |
| `unicode` | String! | The emoji in unicode |
| `unicodeVersion` | String! | The unicode version for this emoji |
| `user` | User! | The user who awarded the emoji |
| `description` | String! | The emoji description. |
| `emoji` | String! | The emoji as an icon. |
| `name` | String! | The emoji name. |
| `unicode` | String! | The emoji in unicode. |
| `unicodeVersion` | String! | The unicode version for this emoji. |
| `user` | User! | The user who awarded the emoji. |
### AwardEmojiAddPayload
......@@ -244,14 +244,14 @@ Represents a project or group board.
| ----- | ---- | ----------- |
| `assignee` | User | The board assignee |
| `epics` | BoardEpicConnection | Epics associated with board issues |
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden |
| `hideClosedList` | Boolean | Whether or not closed list is hidden |
| `id` | ID! | ID (global ID) of the board |
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. |
| `hideClosedList` | Boolean | Whether or not closed list is hidden. |
| `id` | ID! | ID (global ID) of the board. |
| `iteration` | Iteration | The board iteration. |
| `labels` | LabelConnection | Labels of the board |
| `lists` | BoardListConnection | Lists of the board |
| `lists` | BoardListConnection | Lists of the board. |
| `milestone` | Milestone | The board milestone |
| `name` | String | Name of the board |
| `name` | String | Name of the board. |
| `webPath` | String! | Web path of the board. |
| `webUrl` | String! | Web URL of the board. |
| `weight` | Int | Weight of the board |
......@@ -267,7 +267,7 @@ Represents an epic on an issue board.
| `closedAt` | Time | Timestamp of when the epic was closed |
| `confidential` | Boolean | Indicates if the epic is confidential |
| `createdAt` | Time | Timestamp of when the epic was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues |
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants |
| `description` | String | Description of the epic |
......@@ -323,19 +323,19 @@ Represents a list for an issue board.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `assignee` | User | Assignee in the list |
| `collapsed` | Boolean | Indicates if list is collapsed for this user |
| `id` | ID! | ID (global ID) of the list |
| `issues` | IssueConnection | Board issues |
| `issuesCount` | Int | Count of issues in the list |
| `collapsed` | Boolean | Indicates if list is collapsed for this user. |
| `id` | ID! | ID (global ID) of the list. |
| `issues` | IssueConnection | Board issues. |
| `issuesCount` | Int | Count of issues in the list. |
| `iteration` | Iteration | Iteration of the list |
| `label` | Label | Label of the list |
| `label` | Label | Label of the list. |
| `limitMetric` | ListLimitMetric | The current limit metric for the list |
| `listType` | String! | Type of the list |
| `listType` | String! | Type of the list. |
| `maxIssueCount` | Int | Maximum number of issues in the list |
| `maxIssueWeight` | Int | Maximum weight of issues in the list |
| `milestone` | Milestone | Milestone of the list |
| `position` | Int | Position of list within the board |
| `title` | String! | Title of the list |
| `position` | Int | Position of list within the board. |
| `title` | String! | Title of the list. |
| `totalWeight` | Int | Total weight of all issues in the list |
### BoardListCreatePayload
......@@ -362,8 +362,8 @@ Autogenerated return type of BoardListUpdateLimitMetrics.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `commit` | Commit | Commit for the branch |
| `name` | String! | Name of the branch |
| `commit` | Commit | Commit for the branch. |
| `name` | String! | Name of the branch. |
### BurnupChartDailyTotals
......@@ -396,18 +396,18 @@ Autogenerated return type of CiCdSettingsUpdate.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `errors` | String! => Array | Linting errors |
| `mergedYaml` | String | Merged CI config YAML |
| `stages` | CiConfigStageConnection | Stages of the pipeline |
| `status` | CiConfigStatus | Status of linting, can be either valid or invalid |
| `errors` | String! => Array | Linting errors. |
| `mergedYaml` | String | Merged CI config YAML. |
| `stages` | CiConfigStageConnection | Stages of the pipeline. |
| `status` | CiConfigStatus | Status of linting, can be either valid or invalid. |
### CiConfigGroup
| Field | Type | Description |
| ----- | ---- | ----------- |
| `jobs` | CiConfigJobConnection | Jobs in group |
| `name` | String | Name of the job group |
| `size` | Int | Size of the job group |
| `jobs` | CiConfigJobConnection | Jobs in group. |
| `name` | String | Name of the job group. |
| `size` | Int | Size of the job group. |
### CiConfigJob
......@@ -437,49 +437,49 @@ Autogenerated return type of CiCdSettingsUpdate.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `name` | String | Name of the need |
| `name` | String | Name of the need. |
### CiConfigStage
| Field | Type | Description |
| ----- | ---- | ----------- |
| `groups` | CiConfigGroupConnection | Groups of jobs for the stage |
| `name` | String | Name of the stage |
| `groups` | CiConfigGroupConnection | Groups of jobs for the stage. |
| `name` | String | Name of the stage. |
### CiGroup
| Field | Type | Description |
| ----- | ---- | ----------- |
| `detailedStatus` | DetailedStatus | Detailed status of the group |
| `jobs` | CiJobConnection | Jobs in group |
| `name` | String | Name of the job group |
| `size` | Int | Size of the group |
| `detailedStatus` | DetailedStatus | Detailed status of the group. |
| `jobs` | CiJobConnection | Jobs in group. |
| `name` | String | Name of the job group. |
| `size` | Int | Size of the group. |
### CiJob
| Field | Type | Description |
| ----- | ---- | ----------- |
| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job |
| `detailedStatus` | DetailedStatus | Detailed status of the job |
| `name` | String | Name of the job |
| `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run |
| `pipeline` | Pipeline | Pipeline the job belongs to |
| `scheduledAt` | Time | Schedule for the build |
| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job. |
| `detailedStatus` | DetailedStatus | Detailed status of the job. |
| `name` | String | Name of the job. |
| `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run. |
| `pipeline` | Pipeline | Pipeline the job belongs to. |
| `scheduledAt` | Time | Schedule for the build. |
### CiJobArtifact
| Field | Type | Description |
| ----- | ---- | ----------- |
| `downloadPath` | String | URL for downloading the artifact's file |
| `fileType` | JobArtifactFileType | File type of the artifact |
| `downloadPath` | String | URL for downloading the artifact's file. |
| `fileType` | JobArtifactFileType | File type of the artifact. |
### CiStage
| Field | Type | Description |
| ----- | ---- | ----------- |
| `detailedStatus` | DetailedStatus | Detailed status of the stage |
| `groups` | CiGroupConnection | Group of jobs for the stage |
| `name` | String | Name of the stage |
| `detailedStatus` | DetailedStatus | Detailed status of the stage. |
| `groups` | CiGroupConnection | Group of jobs for the stage. |
| `name` | String | Name of the stage. |
### ClusterAgent
......@@ -554,22 +554,22 @@ Represents the code coverage summary for a project.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `author` | User | Author of the commit |
| `authorGravatar` | String | Commit authors gravatar |
| `authorName` | String | Commit authors name |
| `authoredDate` | Time | Timestamp of when the commit was authored |
| `description` | String | Description of the commit message |
| `author` | User | Author of the commit. |
| `authorGravatar` | String | Commit authors gravatar. |
| `authorName` | String | Commit authors name. |
| `authoredDate` | Time | Timestamp of when the commit was authored. |
| `description` | String | Description of the commit message. |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `id` | ID! | ID (global ID) of the commit |
| `message` | String | Raw commit message |
| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first |
| `sha` | String! | SHA1 ID of the commit |
| `shortId` | String! | Short SHA1 ID of the commit |
| `signatureHtml` | String | Rendered HTML of the commit signature |
| `title` | String | Title of the commit message |
| `id` | ID! | ID (global ID) of the commit. |
| `message` | String | Raw commit message. |
| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first. |
| `sha` | String! | SHA1 ID of the commit. |
| `shortId` | String! | Short SHA1 ID of the commit. |
| `signatureHtml` | String | Rendered HTML of the commit signature. |
| `title` | String | Title of the commit message. |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
| `webPath` | String! | Web path of the commit |
| `webUrl` | String! | Web URL of the commit |
| `webPath` | String! | Web path of the commit. |
| `webUrl` | String! | Web URL of the commit. |
### CommitCreatePayload
......@@ -609,15 +609,15 @@ A tag expiration policy designed to keep only the images that matter most.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created |
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled |
| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain |
| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire |
| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved |
| `nextRunAt` | Time | Next time that this container expiration policy will get executed |
| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire |
| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated |
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule. |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created. |
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled. |
| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain. |
| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire. |
| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved. |
| `nextRunAt` | Time | Next time that this container expiration policy will get executed. |
| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire. |
| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated. |
### ContainerRepository
......@@ -633,7 +633,7 @@ A container repository.
| `location` | String! | URL of the container repository. |
| `name` | String! | Name of the container repository. |
| `path` | String! | Path of the container repository. |
| `project` | Project! | Project of the container registry |
| `project` | Project! | Project of the container registry. |
| `status` | ContainerRepositoryStatus | Status of the container repository. |
| `tagsCount` | Int! | Number of tags associated with this image. |
| `updatedAt` | Time! | Timestamp when the container repository was updated. |
......@@ -652,9 +652,9 @@ Details of a container repository.
| `location` | String! | URL of the container repository. |
| `name` | String! | Name of the container repository. |
| `path` | String! | Path of the container repository. |
| `project` | Project! | Project of the container registry |
| `project` | Project! | Project of the container registry. |
| `status` | ContainerRepositoryStatus | Status of the container repository. |
| `tags` | ContainerRepositoryTagConnection | Tags of the container repository |
| `tags` | ContainerRepositoryTagConnection | Tags of the container repository. |
| `tagsCount` | Int! | Number of tags associated with this image. |
| `updatedAt` | Time! | Timestamp when the container repository was updated. |
......@@ -853,10 +853,10 @@ A custom emoji uploaded by user.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `external` | Boolean! | Whether the emoji is an external link |
| `id` | CustomEmojiID! | The ID of the emoji |
| `name` | String! | The name of the emoji |
| `url` | String! | The link to file of the emoji |
| `external` | Boolean! | Whether the emoji is an external link. |
| `id` | CustomEmojiID! | The ID of the emoji. |
| `name` | String! | The name of the emoji. |
| `url` | String! | The link to file of the emoji. |
### DastOnDemandScanCreatePayload
......@@ -1031,9 +1031,9 @@ The response from the AdminSidekiqQueuesDeleteJobs mutation.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe |
| `deletedJobs` | Int | The number of matching jobs deleted |
| `queueSize` | Int | The queue size after processing |
| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe. |
| `deletedJobs` | Int | The number of matching jobs deleted. |
| `queueSize` | Int | The queue size after processing. |
### Design
......@@ -1041,20 +1041,20 @@ A single design.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `diffRefs` | DiffRefs! | The diff refs for this design. |
| `discussions` | DiscussionConnection! | All discussions on this noteable |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
| `id` | ID! | The ID of this design |
| `image` | String! | The URL of the full-sized image |
| `event` | DesignVersionEvent! | How this design was changed in the current version. |
| `filename` | String! | The filename of the design. |
| `fullPath` | String! | The full path to the design file. |
| `id` | ID! | The ID of this design. |
| `image` | String! | The URL of the full-sized image. |
| `imageV432x230` | String | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated |
| `issue` | Issue! | The issue the design belongs to |
| `issue` | Issue! | The issue the design belongs to. |
| `notes` | NoteConnection! | All notes on this noteable |
| `notesCount` | Int! | The total count of user-created notes for this design |
| `project` | Project! | The project the design belongs to |
| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first |
| `notesCount` | Int! | The total count of user-created notes for this design. |
| `project` | Project! | The project the design belongs to. |
| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first. |
### DesignAtVersion
......@@ -1062,18 +1062,18 @@ A design pinned to a specific version. The image field reflects the design as of
| Field | Type | Description |
| ----- | ---- | ----------- |
| `design` | Design! | The underlying design |
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
| `id` | ID! | The ID of this design |
| `image` | String! | The URL of the full-sized image |
| `design` | Design! | The underlying design. |
| `diffRefs` | DiffRefs! | The diff refs for this design. |
| `event` | DesignVersionEvent! | How this design was changed in the current version. |
| `filename` | String! | The filename of the design. |
| `fullPath` | String! | The full path to the design file. |
| `id` | ID! | The ID of this design. |
| `image` | String! | The URL of the full-sized image. |
| `imageV432x230` | String | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated |
| `issue` | Issue! | The issue the design belongs to |
| `notesCount` | Int! | The total count of user-created notes for this design |
| `project` | Project! | The project the design belongs to |
| `version` | DesignVersion! | The version this design-at-versions is pinned to |
| `issue` | Issue! | The issue the design belongs to. |
| `notesCount` | Int! | The total count of user-created notes for this design. |
| `project` | Project! | The project the design belongs to. |
| `version` | DesignVersion! | The version this design-at-versions is pinned to. |
### DesignCollection
......@@ -1081,21 +1081,21 @@ A collection of designs.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `copyState` | DesignCollectionCopyState | Copy state of the design collection |
| `design` | Design | Find a specific design |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
| `designs` | DesignConnection! | All designs for the design collection |
| `issue` | Issue! | Issue associated with the design collection |
| `project` | Project! | Project associated with the design collection |
| `version` | DesignVersion | A specific version |
| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first |
| `copyState` | DesignCollectionCopyState | Copy state of the design collection. |
| `design` | Design | Find a specific design. |
| `designAtVersion` | DesignAtVersion | Find a design as of a version. |
| `designs` | DesignConnection! | All designs for the design collection. |
| `issue` | Issue! | Issue associated with the design collection. |
| `project` | Project! | Project associated with the design collection. |
| `version` | DesignVersion | A specific version. |
| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first. |
### DesignManagement
| Field | Type | Description |
| ----- | ---- | ----------- |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
| `version` | DesignVersion | Find a version |
| `designAtVersion` | DesignAtVersion | Find a design as of a version. |
| `version` | DesignVersion | Find a version. |
### DesignManagementDeletePayload
......@@ -1134,11 +1134,11 @@ A specific version in which designs were added, modified or deleted.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version |
| `designs` | DesignConnection! | All designs that were changed in the version |
| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version |
| `id` | ID! | ID of the design version |
| `sha` | ID! | SHA of the design version |
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version. |
| `designs` | DesignConnection! | All designs that were changed in the version. |
| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version. |
| `id` | ID! | ID of the design version. |
| `sha` | ID! | SHA of the design version. |
### DestroyBoardListPayload
......@@ -1213,15 +1213,15 @@ Autogenerated return type of DestroySnippet.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title |
| `detailsPath` | String | Path of the details for the status |
| `favicon` | String | Favicon of the status |
| `group` | String | Group of the status |
| `hasDetails` | Boolean | Indicates if the status has further details |
| `icon` | String | Icon of the status |
| `label` | String | Label of the status |
| `text` | String | Text of the status |
| `tooltip` | String | Tooltip associated with the status |
| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title. |
| `detailsPath` | String | Path of the details for the status. |
| `favicon` | String | Favicon of the status. |
| `group` | String | Group of the status. |
| `hasDetails` | Boolean | Indicates if the status has further details. |
| `icon` | String | Icon of the status. |
| `label` | String | Label of the status. |
| `text` | String | Text of the status. |
| `tooltip` | String | Tooltip associated with the status. |
### DevopsAdoptionSegment
......@@ -1271,9 +1271,9 @@ Snapshot.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `baseSha` | String | Merge base of the branch the comment was made on |
| `headSha` | String! | SHA of the HEAD at the time the comment was made |
| `startSha` | String! | SHA of the branch being compared against |
| `baseSha` | String | Merge base of the branch the comment was made on. |
| `headSha` | String! | SHA of the HEAD at the time the comment was made. |
| `startSha` | String! | SHA of the branch being compared against. |
### DiffStats
......@@ -1281,9 +1281,9 @@ Changes to a single file.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `additions` | Int! | Number of lines added to this file |
| `deletions` | Int! | Number of lines deleted from this file |
| `path` | String! | File path, relative to repository root |
| `additions` | Int! | Number of lines added to this file. |
| `deletions` | Int! | Number of lines deleted from this file. |
| `path` | String! | File path, relative to repository root. |
### DiffStatsSummary
......@@ -1291,10 +1291,10 @@ Aggregated summary of changes.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `additions` | Int! | Number of lines added |
| `changes` | Int! | Number of lines changed |
| `deletions` | Int! | Number of lines deleted |
| `fileCount` | Int! | Number of files changed |
| `additions` | Int! | Number of lines added. |
| `changes` | Int! | Number of lines changed. |
| `deletions` | Int! | Number of lines deleted. |
| `fileCount` | Int! | Number of files changed. |
### Discussion
......@@ -1335,12 +1335,12 @@ Describes where code is deployed for a project.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `id` | ID! | ID of the environment |
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned |
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment |
| `name` | String! | Human-readable name of the environment |
| `id` | ID! | ID of the environment. |
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. |
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment. |
| `name` | String! | Human-readable name of the environment. |
| `path` | String! | The path to the environment. |
| `state` | String! | State of the environment, for example: available/stopped |
| `state` | String! | State of the environment, for example: available/stopped. |
### EnvironmentsCanaryIngressUpdatePayload
......@@ -1362,7 +1362,7 @@ Represents an epic.
| `closedAt` | Time | Timestamp of when the epic was closed |
| `confidential` | Boolean | Indicates if the epic is confidential |
| `createdAt` | Time | Timestamp of when the epic was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues |
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants |
| `description` | String | Description of the epic |
......@@ -1468,7 +1468,7 @@ Relationship between an epic and an issue.
| `confidential` | Boolean! | Indicates the issue is confidential |
| `createNoteEmail` | String | User specific email address for the issue |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
......@@ -1614,11 +1614,11 @@ Represents an external issue.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | Timestamp of the issue's creation |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled |
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration |
| `id` | ID! | Internal ID of the Grafana integration |
| `updatedAt` | Time! | Timestamp of the issue's last activity |
| `createdAt` | Time! | Timestamp of the issue's creation. |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled. |
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration. |
| `id` | ID! | Internal ID of the Grafana integration. |
| `updatedAt` | Time! | Timestamp of the issue's last activity. |
### Group
......@@ -1626,19 +1626,19 @@ Represents an external issue.
| ----- | ---- | ----------- |
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes |
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes |
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group |
| `avatarUrl` | String | Avatar URL of the group |
| `board` | Board | A single board of the group |
| `boards` | BoardConnection | Boards of the group |
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group. |
| `avatarUrl` | String | Avatar URL of the group. |
| `board` | Board | A single board of the group. |
| `boards` | BoardConnection | Boards of the group. |
| `codeCoverageActivities` | CodeCoverageActivityConnection | Represents the code coverage activity for this group |
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group |
| `containerRepositoriesCount` | Int! | Number of container repositories in the group |
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group. |
| `containerRepositoriesCount` | Int! | Number of container repositories in the group. |
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit |
| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled. |
| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. |
| `description` | String | Description of the namespace |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled |
| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled. |
| `epic` | Epic | Find a single epic |
| `epicBoard` | EpicBoard | Find a single epic board |
| `epicBoards` | EpicBoardConnection | Find epic boards |
......@@ -1646,37 +1646,37 @@ Represents an external issue.
| `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `groupMembers` | GroupMemberConnection | A membership of a user within this group |
| `groupMembers` | GroupMemberConnection | A membership of a user within this group. |
| `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |
| `id` | ID! | ID of the namespace |
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase |
| `issues` | IssueConnection | Issues for projects in this group |
| `issues` | IssueConnection | Issues for projects in this group. |
| `iterations` | IterationConnection | Find iterations |
| `label` | Label | A label available on this group |
| `labels` | LabelConnection | Labels available on this group |
| `label` | Label | A label available on this group. |
| `labels` | LabelConnection | Labels available on this group. |
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned |
| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group |
| `milestones` | MilestoneConnection | Milestones of the group |
| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned. |
| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group. |
| `milestones` | MilestoneConnection | Milestones of the group. |
| `name` | String! | Name of the namespace |
| `packageSettings` | PackageSettings | The package settings for the namespace |
| `parent` | Group | Parent group |
| `parent` | Group | Parent group. |
| `path` | String! | Path of the namespace |
| `projectCreationLevel` | String | The permission level required to create projects in the group |
| `projectCreationLevel` | String | The permission level required to create projects in the group. |
| `projects` | ProjectConnection! | Projects within this namespace |
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit |
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication |
| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication. |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented |
| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented. |
| `stats` | GroupStats | Group statistics |
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes |
| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group |
| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group. |
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
| `timelogs` | TimelogConnection! | Time logged in issues by group members |
| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes |
| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes |
| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced |
| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced. |
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the namespace |
| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the projects in the group and its subgroups |
......@@ -1685,7 +1685,7 @@ Represents an external issue.
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilties of the group and its subgroups |
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups |
| `webUrl` | String! | Web URL of the group |
| `webUrl` | String! | Web URL of the group. |
### GroupMember
......@@ -1697,7 +1697,7 @@ Represents a Group Membership.
| `createdAt` | Time | Date and time the membership was created |
| `createdBy` | User | User that authorized membership |
| `expiresAt` | Time | Date and time the membership expires |
| `group` | Group | Group that a User is a member of |
| `group` | Group | Group that a User is a member of. |
| `id` | ID! | ID of the member |
| `updatedAt` | Time | Date and time the membership was last updated |
| `user` | User! | User that is associated with the member object |
......@@ -1806,9 +1806,9 @@ Represents a recorded measurement (object count) for the Admins.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | Object count |
| `identifier` | MeasurementIdentifier! | The type of objects being measured |
| `recordedAt` | Time | The time the measurement was recorded |
| `count` | Int! | Object count. |
| `identifier` | MeasurementIdentifier! | The type of objects being measured. |
| `recordedAt` | Time | The time the measurement was recorded. |
### Issue
......@@ -1823,7 +1823,7 @@ Represents a recorded measurement (object count) for the Admins.
| `confidential` | Boolean! | Indicates the issue is confidential |
| `createNoteEmail` | String | User specific email address for the issue |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
......@@ -2134,7 +2134,7 @@ Autogenerated return type of MarkAsSpamSnippet.
| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits |
| `conflicts` | Boolean! | Indicates if the merge request has conflicts |
| `createdAt` | Time! | Timestamp of when the merge request was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description |
| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request |
......@@ -2609,49 +2609,49 @@ Information about pagination in a connection..
| Field | Type | Description |
| ----- | ---- | ----------- |
| `active` | Boolean! | Indicates if the pipeline is active |
| `beforeSha` | String | Base SHA of the source branch |
| `cancelable` | Boolean! | Specifies if a pipeline can be canceled |
| `committedAt` | Time | Timestamp of the pipeline's commit |
| `active` | Boolean! | Indicates if the pipeline is active. |
| `beforeSha` | String | Base SHA of the source branch. |
| `cancelable` | Boolean! | Specifies if a pipeline can be canceled. |
| `committedAt` | Time | Timestamp of the pipeline's commit. |
| `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
| `coverage` | Float | Coverage percentage |
| `createdAt` | Time! | Timestamp of the pipeline's creation |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline |
| `downstream` | PipelineConnection | Pipelines this pipeline will trigger |
| `duration` | Int | Duration of the pipeline in seconds |
| `finishedAt` | Time | Timestamp of the pipeline's completion |
| `id` | ID! | ID of the pipeline |
| `iid` | String! | Internal ID of the pipeline |
| `jobs` | CiJobConnection | Jobs belonging to the pipeline |
| `path` | String | Relative path to the pipeline's page |
| `project` | Project | Project the pipeline belongs to |
| `retryable` | Boolean! | Specifies if a pipeline can be retried |
| `coverage` | Float | Coverage percentage. |
| `createdAt` | Time! | Timestamp of the pipeline's creation. |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline. |
| `downstream` | PipelineConnection | Pipelines this pipeline will trigger. |
| `duration` | Int | Duration of the pipeline in seconds. |
| `finishedAt` | Time | Timestamp of the pipeline's completion. |
| `id` | ID! | ID of the pipeline. |
| `iid` | String! | Internal ID of the pipeline. |
| `jobs` | CiJobConnection | Jobs belonging to the pipeline. |
| `path` | String | Relative path to the pipeline's page. |
| `project` | Project | Project the pipeline belongs to. |
| `retryable` | Boolean! | Specifies if a pipeline can be retried. |
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline |
| `sha` | String! | SHA of the pipeline's commit |
| `sourceJob` | CiJob | Job where pipeline was triggered from |
| `stages` | CiStageConnection | Stages of the pipeline |
| `startedAt` | Time | Timestamp when the pipeline was started |
| `sha` | String! | SHA of the pipeline's commit. |
| `sourceJob` | CiJob | Job where pipeline was triggered from. |
| `stages` | CiStageConnection | Stages of the pipeline. |
| `startedAt` | Time | Timestamp when the pipeline was started. |
| `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) |
| `updatedAt` | Time! | Timestamp of the pipeline's last activity |
| `upstream` | Pipeline | Pipeline that triggered the pipeline |
| `user` | User | Pipeline user |
| `updatedAt` | Time! | Timestamp of the pipeline's last activity. |
| `upstream` | Pipeline | Pipeline that triggered the pipeline. |
| `user` | User | Pipeline user. |
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
### PipelineAnalytics
| Field | Type | Description |
| ----- | ---- | ----------- |
| `monthPipelinesLabels` | String! => Array | Labels for the monthly pipeline count |
| `monthPipelinesSuccessful` | Int! => Array | Total monthly successful pipeline count |
| `monthPipelinesTotals` | Int! => Array | Total monthly pipeline count |
| `pipelineTimesLabels` | String! => Array | Pipeline times labels |
| `pipelineTimesValues` | Int! => Array | Pipeline times |
| `weekPipelinesLabels` | String! => Array | Labels for the weekly pipeline count |
| `weekPipelinesSuccessful` | Int! => Array | Total weekly successful pipeline count |
| `weekPipelinesTotals` | Int! => Array | Total weekly pipeline count |
| `yearPipelinesLabels` | String! => Array | Labels for the yearly pipeline count |
| `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count |
| `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count |
| `monthPipelinesLabels` | String! => Array | Labels for the monthly pipeline count. |
| `monthPipelinesSuccessful` | Int! => Array | Total monthly successful pipeline count. |
| `monthPipelinesTotals` | Int! => Array | Total monthly pipeline count. |
| `pipelineTimesLabels` | String! => Array | Pipeline times labels. |
| `pipelineTimesValues` | Int! => Array | Pipeline times. |
| `weekPipelinesLabels` | String! => Array | Labels for the weekly pipeline count. |
| `weekPipelinesSuccessful` | Int! => Array | Total weekly successful pipeline count. |
| `weekPipelinesTotals` | Int! => Array | Total weekly pipeline count. |
| `yearPipelinesLabels` | String! => Array | Labels for the yearly pipeline count. |
| `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count. |
| `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count. |
### PipelineCancelPayload
......@@ -3003,10 +3003,10 @@ Evidence for a release.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `collectedAt` | Time | Timestamp when the evidence was collected |
| `filepath` | String | URL from where the evidence can be downloaded |
| `id` | ID! | ID of the evidence |
| `sha` | String | SHA1 ID of the evidence hash |
| `collectedAt` | Time | Timestamp when the evidence was collected. |
| `filepath` | String | URL from where the evidence can be downloaded. |
| `id` | ID! | ID of the evidence. |
| `sha` | String | SHA1 ID of the evidence hash. |
### ReleaseLinks
......@@ -3158,23 +3158,23 @@ Autogenerated return type of RunDASTScan.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `downloadLocation` | String! | Download location for the runner for the platform architecture |
| `name` | String! | Name of the runner platform architecture |
| `downloadLocation` | String! | Download location for the runner for the platform architecture. |
| `name` | String! | Name of the runner platform architecture. |
### RunnerPlatform
| Field | Type | Description |
| ----- | ---- | ----------- |
| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform |
| `humanReadableName` | String! | Human readable name of the runner platform |
| `name` | String! | Name slug of the runner platform |
| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform. |
| `humanReadableName` | String! | Human readable name of the runner platform. |
| `name` | String! | Name slug of the runner platform. |
### RunnerSetup
| Field | Type | Description |
| ----- | ---- | ----------- |
| `installInstructions` | String! | Instructions for installing the runner on the specified architecture |
| `registerInstructions` | String | Instructions for registering the runner |
| `installInstructions` | String! | Instructions for installing the runner on the specified architecture. |
| `registerInstructions` | String | Instructions for registering the runner. |
### SastCiConfiguration
......@@ -3272,34 +3272,34 @@ A Sentry error.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | Count of occurrences |
| `culprit` | String! | Culprit of the error |
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance |
| `externalUrl` | String! | External URL of the error |
| `firstReleaseLastCommit` | String | Commit the error was first seen |
| `firstReleaseShortVersion` | String | Release short version the error was first seen |
| `firstReleaseVersion` | String | Release version the error was first seen |
| `firstSeen` | Time! | Timestamp when the error was first seen |
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error |
| `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version |
| `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error |
| `gitlabIssuePath` | String | URL of GitLab Issue |
| `id` | ID! | ID (global ID) of the error |
| `lastReleaseLastCommit` | String | Commit the error was last seen |
| `lastReleaseShortVersion` | String | Release short version the error was last seen |
| `lastReleaseVersion` | String | Release version the error was last seen |
| `lastSeen` | Time! | Timestamp when the error was last seen |
| `message` | String | Sentry metadata message of the error |
| `sentryId` | String! | ID (Sentry ID) of the error |
| `sentryProjectId` | ID! | ID of the project (Sentry project) |
| `sentryProjectName` | String! | Name of the project affected by the error |
| `sentryProjectSlug` | String! | Slug of the project affected by the error |
| `shortId` | String! | Short ID (Sentry ID) of the error |
| `status` | SentryErrorStatus! | Status of the error |
| `tags` | SentryErrorTags! | Tags associated with the Sentry Error |
| `title` | String! | Title of the error |
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
| `count` | Int! | Count of occurrences. |
| `culprit` | String! | Culprit of the error. |
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance. |
| `externalUrl` | String! | External URL of the error. |
| `firstReleaseLastCommit` | String | Commit the error was first seen. |
| `firstReleaseShortVersion` | String | Release short version the error was first seen. |
| `firstReleaseVersion` | String | Release version the error was first seen. |
| `firstSeen` | Time! | Timestamp when the error was first seen. |
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error. |
| `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version. |
| `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error. |
| `gitlabIssuePath` | String | URL of GitLab Issue. |
| `id` | ID! | ID (global ID) of the error. |
| `lastReleaseLastCommit` | String | Commit the error was last seen. |
| `lastReleaseShortVersion` | String | Release short version the error was last seen. |
| `lastReleaseVersion` | String | Release version the error was last seen. |
| `lastSeen` | Time! | Timestamp when the error was last seen. |
| `message` | String | Sentry metadata message of the error. |
| `sentryId` | String! | ID (Sentry ID) of the error. |
| `sentryProjectId` | ID! | ID of the project (Sentry project). |
| `sentryProjectName` | String! | Name of the project affected by the error. |
| `sentryProjectSlug` | String! | Slug of the project affected by the error. |
| `shortId` | String! | Short ID (Sentry ID) of the error. |
| `status` | SentryErrorStatus! | Status of the error. |
| `tags` | SentryErrorTags! | Tags associated with the Sentry Error. |
| `title` | String! | Title of the error. |
| `type` | String! | Type of the error. |
| `userCount` | Int! | Count of users affected by the error. |
### SentryError
......@@ -3307,23 +3307,23 @@ A Sentry error. A simplified version of SentryDetailedError.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | Count of occurrences |
| `culprit` | String! | Culprit of the error |
| `externalUrl` | String! | External URL of the error |
| `firstSeen` | Time! | Timestamp when the error was first seen |
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error |
| `id` | ID! | ID (global ID) of the error |
| `lastSeen` | Time! | Timestamp when the error was last seen |
| `message` | String | Sentry metadata message of the error |
| `sentryId` | String! | ID (Sentry ID) of the error |
| `sentryProjectId` | ID! | ID of the project (Sentry project) |
| `sentryProjectName` | String! | Name of the project affected by the error |
| `sentryProjectSlug` | String! | Slug of the project affected by the error |
| `shortId` | String! | Short ID (Sentry ID) of the error |
| `status` | SentryErrorStatus! | Status of the error |
| `title` | String! | Title of the error |
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
| `count` | Int! | Count of occurrences. |
| `culprit` | String! | Culprit of the error. |
| `externalUrl` | String! | External URL of the error. |
| `firstSeen` | Time! | Timestamp when the error was first seen. |
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error. |
| `id` | ID! | ID (global ID) of the error. |
| `lastSeen` | Time! | Timestamp when the error was last seen. |
| `message` | String | Sentry metadata message of the error. |
| `sentryId` | String! | ID (Sentry ID) of the error. |
| `sentryProjectId` | ID! | ID of the project (Sentry project). |
| `sentryProjectName` | String! | Name of the project affected by the error. |
| `sentryProjectSlug` | String! | Slug of the project affected by the error. |
| `shortId` | String! | Short ID (Sentry ID) of the error. |
| `status` | SentryErrorStatus! | Status of the error. |
| `title` | String! | Title of the error. |
| `type` | String! | Type of the error. |
| `userCount` | Int! | Count of users affected by the error. |
### SentryErrorCollection
......@@ -3331,17 +3331,17 @@ An object containing a collection of Sentry errors, and a detailed error.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error |
| `errors` | SentryErrorConnection | Collection of Sentry Errors |
| `externalUrl` | String | External URL for Sentry |
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. |
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error. |
| `errors` | SentryErrorConnection | Collection of Sentry Errors. |
| `externalUrl` | String | External URL for Sentry. |
### SentryErrorFrequency
| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | Count of errors received since the previously recorded time |
| `time` | Time! | Time the error frequency stats were recorded |
| `count` | Int! | Count of errors received since the previously recorded time. |
| `time` | Time! | Time the error frequency stats were recorded. |
### SentryErrorStackTrace
......@@ -3349,9 +3349,9 @@ An object containing a stack trace entry for a Sentry error.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `dateReceived` | String! | Time the stack trace was received by Sentry |
| `issueId` | String! | ID of the Sentry error |
| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error |
| `dateReceived` | String! | Time the stack trace was received by Sentry. |
| `issueId` | String! | ID of the Sentry error. |
| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error. |
### SentryErrorStackTraceContext
......@@ -3359,8 +3359,8 @@ An object context for a Sentry error stack trace.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `code` | String! | Code number of the context |
| `line` | Int! | Line number of the context |
| `code` | String! | Code number of the context. |
| `line` | Int! | Line number of the context. |
### SentryErrorStackTraceEntry
......@@ -3368,11 +3368,11 @@ An object containing a stack trace entry for a Sentry error.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `col` | String | Function in which the Sentry error occurred |
| `fileName` | String | File in which the Sentry error occurred |
| `function` | String | Function in which the Sentry error occurred |
| `line` | String | Function in which the Sentry error occurred |
| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error |
| `col` | String | Function in which the Sentry error occurred. |
| `fileName` | String | File in which the Sentry error occurred. |
| `function` | String | Function in which the Sentry error occurred. |
| `line` | String | Function in which the Sentry error occurred. |
| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error. |
### SentryErrorTags
......@@ -3380,8 +3380,8 @@ State of a Sentry error.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `level` | String | Severity level of the Sentry Error |
| `logger` | String | Logger of the Sentry Error |
| `level` | String | Severity level of the Sentry Error. |
| `logger` | String | Logger of the Sentry Error. |
### Snippet
......@@ -3472,11 +3472,11 @@ Represents the Geo sync and verification state of a snippet repository.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `buttonTitle` | String | Title for the button, for example: Retry this job |
| `icon` | String | Icon used in the action button |
| `method` | String | Method for the action, for example: :post |
| `path` | String | Path for the action |
| `title` | String | Title for the action, for example: Retry |
| `buttonTitle` | String | Title for the button, for example: Retry this job. |
| `icon` | String | Icon used in the action button. |
| `method` | String | Method for the action, for example: :post. |
| `path` | String | Path for the action. |
| `title` | String | Title for the action, for example: Retry. |
### Submodule
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7