Skip to content

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

Fix Graphql/Descriptions EE mutation 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 offenses in `ee/app/graphql/mutations` and
`ee/app/graphql/ee/mutations` and removes their exclusion of them from
`.rubocop_manual_todo.yml`.

The changes were generated using the following autocorrect:

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

https://gitlab.com/gitlab-org/gitlab/-/issues/292426
parent 8744311a
Hide whitespace changes
Inline Side-by-side
Showing with 384 additions and 426 deletions
.rubocop_manual_todo.yml
View file @ c64366eb
......@@ -881,10 +881,6 @@ Graphql/Descriptions:
- 'app/graphql/types/tree/tree_type.rb'
- 'app/graphql/types/user_status_type.rb'
- 'app/graphql/types/user_type.rb'
- 'ee/app/graphql/ee/mutations/boards/issues/issue_move_list.rb'
- 'ee/app/graphql/ee/mutations/boards/lists/create.rb'
- 'ee/app/graphql/ee/mutations/issues/create.rb'
- 'ee/app/graphql/ee/mutations/issues/update.rb'
- 'ee/app/graphql/ee/resolvers/issues_resolver.rb'
- 'ee/app/graphql/ee/resolvers/namespace_projects_resolver.rb'
- 'ee/app/graphql/ee/types/board_list_type.rb'
......@@ -898,44 +894,6 @@ Graphql/Descriptions:
- 'ee/app/graphql/ee/types/namespace_type.rb'
- 'ee/app/graphql/ee/types/project_type.rb'
- 'ee/app/graphql/ee/types/query_type.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/delete.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/mixins.rb'
- 'ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/update.rb'
- 'ee/app/graphql/mutations/boards/lists/update_limit_metrics.rb'
- 'ee/app/graphql/mutations/boards/update.rb'
- 'ee/app/graphql/mutations/boards/update_epic_user_preferences.rb'
- 'ee/app/graphql/mutations/compliance_management/frameworks/destroy.rb'
- 'ee/app/graphql/mutations/compliance_management/frameworks/update.rb'
- 'ee/app/graphql/mutations/clusters/agent_tokens/create.rb'
- 'ee/app/graphql/mutations/clusters/agent_tokens/delete.rb'
- 'ee/app/graphql/mutations/clusters/agents/create.rb'
- 'ee/app/graphql/mutations/clusters/agents/delete.rb'
- 'ee/app/graphql/mutations/concerns/mutations/shared_epic_arguments.rb'
- 'ee/app/graphql/mutations/epic_tree/reorder.rb'
- 'ee/app/graphql/mutations/epics/add_issue.rb'
- 'ee/app/graphql/mutations/epics/base.rb'
- 'ee/app/graphql/mutations/epics/create.rb'
- 'ee/app/graphql/mutations/epics/set_subscription.rb'
- 'ee/app/graphql/mutations/epics/update.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/create.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/destroy.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/oncall_schedule_base.rb'
- 'ee/app/graphql/mutations/incident_management/oncall_schedule/update.rb'
- 'ee/app/graphql/mutations/instance_security_dashboard/add_project.rb'
- 'ee/app/graphql/mutations/instance_security_dashboard/remove_project.rb'
- 'ee/app/graphql/mutations/issues/common_ee_mutation_arguments.rb'
- 'ee/app/graphql/mutations/issues/promote_to_epic.rb'
- 'ee/app/graphql/mutations/issues/set_weight.rb'
- 'ee/app/graphql/mutations/iterations/create.rb'
- 'ee/app/graphql/mutations/namespaces/base.rb'
- 'ee/app/graphql/mutations/quality_management/test_cases/create.rb'
- 'ee/app/graphql/mutations/requirements_management/base_requirement.rb'
- 'ee/app/graphql/mutations/requirements_management/update_requirement.rb'
- 'ee/app/graphql/mutations/security/ci_configuration/configure_sast.rb'
- 'ee/app/graphql/mutations/vulnerabilities/confirm.rb'
- 'ee/app/graphql/mutations/vulnerabilities/dismiss.rb'
- 'ee/app/graphql/mutations/vulnerabilities/resolve.rb'
- 'ee/app/graphql/mutations/vulnerabilities/revert_to_detected.rb'
- 'ee/app/graphql/resolvers/board_groupings/epics_resolver.rb'
- 'ee/app/graphql/resolvers/boards/epic_boards_resolver.rb'
- 'ee/app/graphql/resolvers/ci/code_coverage_activities_resolver.rb'
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ c64366eb
......@@ -75,7 +75,7 @@ input AddProjectToSecurityDashboardInput {
clientMutationId: String
"""
ID of the project to be added to Instance Security Dashboard
ID of the project to be added to Instance Security Dashboard.
"""
id: ProjectID!
}
......@@ -95,7 +95,7 @@ type AddProjectToSecurityDashboardPayload {
errors: [String!]!
"""
Project that was added to the Instance Security Dashboard
Project that was added to the Instance Security Dashboard.
"""
project: Project
}
......@@ -2131,7 +2131,7 @@ Autogenerated input type of BoardListCreate
"""
input BoardListCreateInput {
"""
Global ID of an existing user
Global ID of an existing user.
"""
assigneeId: UserID
......@@ -2151,7 +2151,7 @@ input BoardListCreateInput {
clientMutationId: String
"""
Global ID of an existing iteration
Global ID of an existing iteration.
"""
iterationId: IterationID
......@@ -2161,7 +2161,7 @@ input BoardListCreateInput {
labelId: LabelID
"""
Global ID of an existing milestone
Global ID of an existing milestone.
"""
milestoneId: MilestoneID
}
......@@ -2246,7 +2246,7 @@ type BoardListUpdateLimitMetricsPayload {
errors: [String!]!
"""
The updated list
The updated list.
"""
list: BoardList
}
......@@ -3055,7 +3055,7 @@ input ClusterAgentDeleteInput {
clientMutationId: String
"""
Global ID of the cluster agent that will be deleted
Global ID of the cluster agent that will be deleted.
"""
id: ClustersAgentID!
}
......@@ -3142,7 +3142,7 @@ input ClusterAgentTokenCreateInput {
clientMutationId: String
"""
Global ID of the cluster agent that will be associated with the new token
Global ID of the cluster agent that will be associated with the new token.
"""
clusterAgentId: ClustersAgentID!
}
......@@ -3162,12 +3162,12 @@ type ClusterAgentTokenCreatePayload {
errors: [String!]!
"""
Token secret value. Make sure you save it - you won't be able to access it again
Token secret value. Make sure you save it - you won't be able to access it again.
"""
secret: String
"""
Token created after mutation
Token created after mutation.
"""
token: ClusterAgentToken
}
......@@ -3182,7 +3182,7 @@ input ClusterAgentTokenDeleteInput {
clientMutationId: String
"""
Global ID of the cluster agent token that will be deleted
Global ID of the cluster agent token that will be deleted.
"""
id: ClustersAgentTokenID!
}
......@@ -3690,12 +3690,12 @@ input ConfigureSastInput {
clientMutationId: String
"""
SAST CI configuration for the project
SAST CI configuration for the project.
"""
configuration: SastCiConfigurationInput!
"""
Full path of the project
Full path of the project.
"""
projectPath: ID!
}
......@@ -3715,12 +3715,12 @@ type ConfigureSastPayload {
errors: [String!]!
"""
Status of creating the commit for the supplied SAST CI configuration
Status of creating the commit for the supplied SAST CI configuration.
"""
status: String!
"""
Redirect path to use when the response is successful
Redirect path to use when the response is successful.
"""
successPath: String
}
......@@ -4426,12 +4426,12 @@ input CreateClusterAgentInput {
clientMutationId: String
"""
Name of the cluster agent
Name of the cluster agent.
"""
name: String!
"""
Full path of the associated project for this cluster agent
Full path of the associated project for this cluster agent.
"""
projectPath: ID!
}
......@@ -4446,7 +4446,7 @@ type CreateClusterAgentPayload {
clientMutationId: String
"""
Cluster agent created after mutation
Cluster agent created after mutation.
"""
clusterAgent: ClusterAgent
......@@ -4551,12 +4551,12 @@ input CreateDevopsAdoptionSegmentInput {
clientMutationId: String
"""
The array of group IDs to set for the segment
The array of group IDs to set for the segment.
"""
groupIds: [GroupID!]
"""
Name of the segment
Name of the segment.
"""
name: String!
}
......@@ -4576,7 +4576,7 @@ type CreateDevopsAdoptionSegmentPayload {
errors: [String!]!
"""
The segment after mutation
The segment after mutation.
"""
segment: DevopsAdoptionSegment
}
......@@ -4646,27 +4646,27 @@ input CreateEpicInput {
clientMutationId: String
"""
Indicates if the epic is confidential
Indicates if the epic is confidential.
"""
confidential: Boolean
"""
The description of the epic
The description of the epic.
"""
description: String
"""
The end date of the epic
The end date of the epic.
"""
dueDateFixed: String
"""
Indicates end date should be sourced from due_date_fixed field not the issue milestones
Indicates end date should be sourced from due_date_fixed field not the issue milestones.
"""
dueDateIsFixed: Boolean
"""
The group the epic to mutate is in
The group the epic to mutate is in.
"""
groupPath: ID!
......@@ -4676,17 +4676,17 @@ input CreateEpicInput {
removeLabelIds: [ID!]
"""
The start date of the epic
The start date of the epic.
"""
startDateFixed: String
"""
Indicates start date should be sourced from start_date_fixed field not the issue milestones
Indicates start date should be sourced from start_date_fixed field not the issue milestones.
"""
startDateIsFixed: Boolean
"""
The title of the epic
The title of the epic.
"""
title: String
}
......@@ -4701,7 +4701,7 @@ type CreateEpicPayload {
clientMutationId: String
"""
The created epic
The created epic.
"""
epic: Epic
......@@ -4801,12 +4801,12 @@ input CreateIssueInput {
dueDate: ISO8601Date
"""
The ID of an epic to associate the issue with
The ID of an epic to associate the issue with.
"""
epicId: EpicID
"""
The desired health status
The desired health status.
"""
healthStatus: HealthStatus
......@@ -4851,7 +4851,7 @@ input CreateIssueInput {
title: String!
"""
The weight of the issue
The weight of the issue.
"""
weight: Int
}
......@@ -4886,32 +4886,32 @@ input CreateIterationInput {
clientMutationId: String
"""
The description of the iteration
The description of the iteration.
"""
description: String
"""
The end date of the iteration
The end date of the iteration.
"""
dueDate: String
"""
The target group for the iteration
The target group for the iteration.
"""
groupPath: ID
"""
The target project for the iteration
The target project for the iteration.
"""
projectPath: ID
"""
The start date of the iteration
The start date of the iteration.
"""
startDate: String
"""
The title of the iteration
The title of the iteration.
"""
title: String
}
......@@ -4931,7 +4931,7 @@ type CreateIterationPayload {
errors: [String!]!
"""
The created iteration
The created iteration.
"""
iteration: Iteration
}
......@@ -4996,17 +4996,17 @@ input CreateRequirementInput {
clientMutationId: String
"""
Description of the requirement
Description of the requirement.
"""
description: String
"""
Full project path the requirement is associated with
Full project path the requirement is associated with.
"""
projectPath: ID!
"""
Title of the requirement
Title of the requirement.
"""
title: String
}
......@@ -5026,7 +5026,7 @@ type CreateRequirementPayload {
errors: [String!]!
"""
Requirement after mutation
Requirement after mutation.
"""
requirement: Requirement
}
......@@ -5106,7 +5106,7 @@ input CreateTestCaseInput {
clientMutationId: String
"""
The test case description
The test case description.
"""
description: String
......@@ -5116,12 +5116,12 @@ input CreateTestCaseInput {
labelIds: [ID!]
"""
The project full path to create the test case
The project full path to create the test case.
"""
projectPath: ID!
"""
The test case title
The test case title.
"""
title: String!
}
......@@ -5141,7 +5141,7 @@ type CreateTestCasePayload {
errors: [String!]!
"""
The test case created
The test case created.
"""
testCase: Issue
}
......@@ -6135,7 +6135,7 @@ input DeleteDevopsAdoptionSegmentInput {
clientMutationId: String
"""
ID of the segment
ID of the segment.
"""
id: AnalyticsDevopsAdoptionSegmentID!
}
......@@ -7100,7 +7100,7 @@ input DestroyComplianceFrameworkInput {
clientMutationId: String
"""
The global ID of the compliance framework to destroy
The global ID of the compliance framework to destroy.
"""
id: ComplianceManagementFrameworkID!
}
......@@ -7799,17 +7799,17 @@ input DismissVulnerabilityInput {
clientMutationId: String
"""
Comment why vulnerability should be dismissed
Comment why vulnerability should be dismissed.
"""
comment: String
"""
Reason why vulnerability should be dismissed
Reason why vulnerability should be dismissed.
"""
dismissalReason: VulnerabilityDismissalReason
"""
ID of the vulnerability to be dismissed
ID of the vulnerability to be dismissed.
"""
id: VulnerabilityID!
}
......@@ -7829,7 +7829,7 @@ type DismissVulnerabilityPayload {
errors: [String!]!
"""
The vulnerability after dismissal
The vulnerability after dismissal.
"""
vulnerability: Vulnerability
}
......@@ -8448,22 +8448,22 @@ input EpicAddIssueInput {
clientMutationId: String
"""
The group the epic to mutate belongs to
The group the epic to mutate belongs to.
"""
groupPath: ID!
"""
The IID of the epic to mutate
The IID of the epic to mutate.
"""
iid: ID!
"""
The IID of the issue to be added
The IID of the issue to be added.
"""
issueIid: String!
"""
The full path of the project the issue belongs to
The full path of the project the issue belongs to.
"""
projectPath: ID!
}
......@@ -8478,12 +8478,12 @@ type EpicAddIssuePayload {
clientMutationId: String
"""
The epic after mutation
The epic after mutation.
"""
epic: Epic
"""
The epic-issue relation
The epic-issue relation.
"""
epicIssue: EpicIssue
......@@ -9278,17 +9278,17 @@ input EpicSetSubscriptionInput {
clientMutationId: String
"""
The group the epic to mutate belongs to
The group the epic to mutate belongs to.
"""
groupPath: ID!
"""
The IID of the epic to mutate
The IID of the epic to mutate.
"""
iid: ID!
"""
The desired state of the subscription
The desired state of the subscription.
"""
subscribedState: Boolean!
}
......@@ -9303,7 +9303,7 @@ type EpicSetSubscriptionPayload {
clientMutationId: String
"""
The epic after mutation
The epic after mutation.
"""
epic: Epic
......@@ -9392,7 +9392,7 @@ Autogenerated input type of EpicTreeReorder
"""
input EpicTreeReorderInput {
"""
The ID of the base epic of the tree
The ID of the base epic of the tree.
"""
baseEpicId: EpicID!
......@@ -9402,7 +9402,7 @@ input EpicTreeReorderInput {
clientMutationId: String
"""
Parameters for updating the tree positions
Parameters for updating the tree positions.
"""
moved: EpicTreeNodeFieldsInputType!
}
......@@ -12184,7 +12184,7 @@ input IssueMoveListInput {
clientMutationId: String
"""
The ID of the parent epic. NULL when removing the association
The ID of the parent epic. NULL when removing the association.
"""
epicId: EpicID
......@@ -12689,7 +12689,7 @@ input IssueSetWeightInput {
projectPath: ID!
"""
The desired weight for the issue
The desired weight for the issue.
"""
weight: Int!
}
......@@ -15733,7 +15733,7 @@ input NamespaceIncreaseStorageTemporarilyInput {
clientMutationId: String
"""
The global ID of the namespace to mutate
The global ID of the namespace to mutate.
"""
id: NamespaceID!
}
......@@ -15753,7 +15753,7 @@ type NamespaceIncreaseStorageTemporarilyPayload {
errors: [String!]!
"""
The namespace after mutation
The namespace after mutation.
"""
namespace: Namespace
}
......@@ -16216,22 +16216,22 @@ input OncallScheduleCreateInput {
clientMutationId: String
"""
The description of the on-call schedule
The description of the on-call schedule.
"""
description: String
"""
The name of the on-call schedule
The name of the on-call schedule.
"""
name: String!
"""
The project to create the on-call schedule in
The project to create the on-call schedule in.
"""
projectPath: ID!
"""
The timezone of the on-call schedule
The timezone of the on-call schedule.
"""
timezone: String!
}
......@@ -16251,7 +16251,7 @@ type OncallScheduleCreatePayload {
errors: [String!]!
"""
The on-call schedule
The on-call schedule.
"""
oncallSchedule: IncidentManagementOncallSchedule
}
......@@ -16266,12 +16266,12 @@ input OncallScheduleDestroyInput {
clientMutationId: String
"""
The on-call schedule internal ID to remove
The on-call schedule internal ID to remove.
"""
iid: String!
"""
The project to remove the on-call schedule from
The project to remove the on-call schedule from.
"""
projectPath: ID!
}
......@@ -16291,7 +16291,7 @@ type OncallScheduleDestroyPayload {
errors: [String!]!
"""
The on-call schedule
The on-call schedule.
"""
oncallSchedule: IncidentManagementOncallSchedule
}
......@@ -16306,27 +16306,27 @@ input OncallScheduleUpdateInput {
clientMutationId: String
"""
The description of the on-call schedule
The description of the on-call schedule.
"""
description: String
"""
The on-call schedule internal ID to update
The on-call schedule internal ID to update.
"""
iid: String!
"""
The name of the on-call schedule
The name of the on-call schedule.
"""
name: String
"""
The project to update the on-call schedule in
The project to update the on-call schedule in.
"""
projectPath: ID!
"""
The timezone of the on-call schedule
The timezone of the on-call schedule.
"""
timezone: String
}
......@@ -16346,7 +16346,7 @@ type OncallScheduleUpdatePayload {
errors: [String!]!
"""
The on-call schedule
The on-call schedule.
"""
oncallSchedule: IncidentManagementOncallSchedule
}
......@@ -19487,7 +19487,7 @@ input PromoteToEpicInput {
clientMutationId: String
"""
The group the promoted epic will belong to
The group the promoted epic will belong to.
"""
groupPath: ID
......@@ -19512,7 +19512,7 @@ type PromoteToEpicPayload {
clientMutationId: String
"""
The epic after issue promotion
The epic after issue promotion.
"""
epic: Epic
......@@ -20843,7 +20843,7 @@ input RemoveProjectFromSecurityDashboardInput {
clientMutationId: String
"""
ID of the project to remove from the Instance Security Dashboard
ID of the project to remove from the Instance Security Dashboard.
"""
id: ProjectID!
}
......@@ -21165,7 +21165,7 @@ input RevertVulnerabilityToDetectedInput {
clientMutationId: String
"""
ID of the vulnerability to be reverted
ID of the vulnerability to be reverted.
"""
id: VulnerabilityID!
}
......@@ -21185,7 +21185,7 @@ type RevertVulnerabilityToDetectedPayload {
errors: [String!]!
"""
The vulnerability after revert
The vulnerability after revert.
"""
vulnerability: Vulnerability
}
......@@ -24297,7 +24297,7 @@ Autogenerated input type of UpdateBoardEpicUserPreferences
"""
input UpdateBoardEpicUserPreferencesInput {
"""
The board global ID
The board global ID.
"""
boardId: BoardID!
......@@ -24307,12 +24307,12 @@ input UpdateBoardEpicUserPreferencesInput {
clientMutationId: String
"""
Whether the epic should be collapsed in the board
Whether the epic should be collapsed in the board.
"""
collapsed: Boolean!
"""
ID of an epic to set preferences for
ID of an epic to set preferences for.
"""
epicId: EpicID!
}
......@@ -24327,7 +24327,7 @@ type UpdateBoardEpicUserPreferencesPayload {
clientMutationId: String
"""
User preferences for the epic in the board after mutation
User preferences for the epic in the board after mutation.
"""
epicUserPreferences: BoardEpicUserPreferences
......@@ -24577,17 +24577,17 @@ input UpdateDevopsAdoptionSegmentInput {
clientMutationId: String
"""
The array of group IDs to set for the segment
The array of group IDs to set for the segment.
"""
groupIds: [GroupID!]
"""
ID of the segment
ID of the segment.
"""
id: AnalyticsDevopsAdoptionSegmentID!
"""
Name of the segment
Name of the segment.
"""
name: String!
}
......@@ -24607,7 +24607,7 @@ type UpdateDevopsAdoptionSegmentPayload {
errors: [String!]!
"""
The segment after mutation
The segment after mutation.
"""
segment: DevopsAdoptionSegment
}
......@@ -24649,32 +24649,32 @@ input UpdateEpicInput {
clientMutationId: String
"""
Indicates if the epic is confidential
Indicates if the epic is confidential.
"""
confidential: Boolean
"""
The description of the epic
The description of the epic.
"""
description: String
"""
The end date of the epic
The end date of the epic.
"""
dueDateFixed: String
"""
Indicates end date should be sourced from due_date_fixed field not the issue milestones
Indicates end date should be sourced from due_date_fixed field not the issue milestones.
"""
dueDateIsFixed: Boolean
"""
The group the epic to mutate is in
The group the epic to mutate is in.
"""
groupPath: ID!
"""
The IID of the epic to mutate
The IID of the epic to mutate.
"""
iid: ID!
......@@ -24684,22 +24684,22 @@ input UpdateEpicInput {
removeLabelIds: [ID!]
"""
The start date of the epic
The start date of the epic.
"""
startDateFixed: String
"""
Indicates start date should be sourced from start_date_fixed field not the issue milestones
Indicates start date should be sourced from start_date_fixed field not the issue milestones.
"""
startDateIsFixed: Boolean
"""
State event for the epic
State event for the epic.
"""
stateEvent: EpicStateEvent
"""
The title of the epic
The title of the epic.
"""
title: String
}
......@@ -24714,7 +24714,7 @@ type UpdateEpicPayload {
clientMutationId: String
"""
The epic after mutation
The epic after mutation.
"""
epic: Epic
......@@ -24799,12 +24799,12 @@ input UpdateIssueInput {
dueDate: ISO8601Date
"""
The ID of the parent epic. NULL when removing the association
The ID of the parent epic. NULL when removing the association.
"""
epicId: EpicID
"""
The desired health status
The desired health status.
"""
healthStatus: HealthStatus
......@@ -24844,7 +24844,7 @@ input UpdateIssueInput {
title: String
"""
The weight of the issue
The weight of the issue.
"""
weight: Int
}
......@@ -25030,32 +25030,32 @@ input UpdateRequirementInput {
clientMutationId: String
"""
Description of the requirement
Description of the requirement.
"""
description: String
"""
The IID of the requirement to update
The IID of the requirement to update.
"""
iid: String!
"""
Creates a test report for the requirement with the given state
Creates a test report for the requirement with the given state.
"""
lastTestReportState: TestReportState
"""
Full project path the requirement is associated with
Full project path the requirement is associated with.
"""
projectPath: ID!
"""
State of the requirement
State of the requirement.
"""
state: RequirementState
"""
Title of the requirement
Title of the requirement.
"""
title: String
}
......@@ -25075,7 +25075,7 @@ type UpdateRequirementPayload {
errors: [String!]!
"""
Requirement after mutation
Requirement after mutation.
"""
requirement: Requirement
}
......@@ -26137,7 +26137,7 @@ input VulnerabilityConfirmInput {
clientMutationId: String
"""
ID of the vulnerability to be confirmed
ID of the vulnerability to be confirmed.
"""
id: VulnerabilityID!
}
......@@ -26157,7 +26157,7 @@ type VulnerabilityConfirmPayload {
errors: [String!]!
"""
The vulnerability after state change
The vulnerability after state change.
"""
vulnerability: Vulnerability
}
......@@ -26192,17 +26192,17 @@ input VulnerabilityDismissInput {
clientMutationId: String
"""
Comment why vulnerability should be dismissed
Comment why vulnerability should be dismissed.
"""
comment: String
"""
Reason why vulnerability should be dismissed
Reason why vulnerability should be dismissed.
"""
dismissalReason: VulnerabilityDismissalReason
"""
ID of the vulnerability to be dismissed
ID of the vulnerability to be dismissed.
"""
id: VulnerabilityID!
}
......@@ -26222,7 +26222,7 @@ type VulnerabilityDismissPayload {
errors: [String!]!
"""
The vulnerability after dismissal
The vulnerability after dismissal.
"""
vulnerability: Vulnerability
}
......@@ -26754,7 +26754,7 @@ input VulnerabilityResolveInput {
clientMutationId: String
"""
ID of the vulnerability to be resolved
ID of the vulnerability to be resolved.
"""
id: VulnerabilityID!
}
......@@ -26774,7 +26774,7 @@ type VulnerabilityResolvePayload {
errors: [String!]!
"""
The vulnerability after state change
The vulnerability after state change.
"""
vulnerability: Vulnerability
}
......@@ -26789,7 +26789,7 @@ input VulnerabilityRevertToDetectedInput {
clientMutationId: String
"""
ID of the vulnerability to be reverted
ID of the vulnerability to be reverted.
"""
id: VulnerabilityID!
}
......@@ -26809,7 +26809,7 @@ type VulnerabilityRevertToDetectedPayload {
errors: [String!]!
"""
The vulnerability after revert
The vulnerability after revert.
"""
vulnerability: Vulnerability
}
......
doc/api/graphql/reference/gitlab_schema.json
View file @ c64366eb
......@@ -221,7 +221,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the project to be added to Instance Security Dashboard",
"description": "ID of the project to be added to Instance Security Dashboard.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -295,7 +295,7 @@
},
{
"name": "project",
"description": "Project that was added to the Instance Security Dashboard",
"description": "Project that was added to the Instance Security Dashboard.",
"args": [
],
......@@ -5682,7 +5682,7 @@
},
{
"name": "milestoneId",
"description": "Global ID of an existing milestone",
"description": "Global ID of an existing milestone.",
"type": {
"kind": "SCALAR",
"name": "MilestoneID",
......@@ -5692,7 +5692,7 @@
},
{
"name": "iterationId",
"description": "Global ID of an existing iteration",
"description": "Global ID of an existing iteration.",
"type": {
"kind": "SCALAR",
"name": "IterationID",
......@@ -5702,7 +5702,7 @@
},
{
"name": "assigneeId",
"description": "Global ID of an existing user",
"description": "Global ID of an existing user.",
"type": {
"kind": "SCALAR",
"name": "UserID",
......@@ -5949,7 +5949,7 @@
},
{
"name": "list",
"description": "The updated list",
"description": "The updated list.",
"args": [
],
......@@ -8291,7 +8291,7 @@
"inputFields": [
{
"name": "id",
"description": "Global ID of the cluster agent that will be deleted",
"description": "Global ID of the cluster agent that will be deleted.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -8568,7 +8568,7 @@
"inputFields": [
{
"name": "clusterAgentId",
"description": "Global ID of the cluster agent that will be associated with the new token",
"description": "Global ID of the cluster agent that will be associated with the new token.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -8642,7 +8642,7 @@
},
{
"name": "secret",
"description": "Token secret value. Make sure you save it - you won't be able to access it again",
"description": "Token secret value. Make sure you save it - you won't be able to access it again.",
"args": [
],
......@@ -8656,7 +8656,7 @@
},
{
"name": "token",
"description": "Token created after mutation",
"description": "Token created after mutation.",
"args": [
],
......@@ -8684,7 +8684,7 @@
"inputFields": [
{
"name": "id",
"description": "Global ID of the cluster agent token that will be deleted",
"description": "Global ID of the cluster agent token that will be deleted.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -10088,7 +10088,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "Full path of the project",
"description": "Full path of the project.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -10102,7 +10102,7 @@
},
{
"name": "configuration",
"description": "SAST CI configuration for the project",
"description": "SAST CI configuration for the project.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -10176,7 +10176,7 @@
},
{
"name": "status",
"description": "Status of creating the commit for the supplied SAST CI configuration",
"description": "Status of creating the commit for the supplied SAST CI configuration.",
"args": [
],
......@@ -10194,7 +10194,7 @@
},
{
"name": "successPath",
"description": "Redirect path to use when the response is successful",
"description": "Redirect path to use when the response is successful.",
"args": [
],
......@@ -12082,7 +12082,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "Full path of the associated project for this cluster agent",
"description": "Full path of the associated project for this cluster agent.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -12096,7 +12096,7 @@
},
{
"name": "name",
"description": "Name of the cluster agent",
"description": "Name of the cluster agent.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -12144,7 +12144,7 @@
},
{
"name": "clusterAgent",
"description": "Cluster agent created after mutation",
"description": "Cluster agent created after mutation.",
"args": [
],
......@@ -12444,7 +12444,7 @@
"inputFields": [
{
"name": "name",
"description": "Name of the segment",
"description": "Name of the segment.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -12458,7 +12458,7 @@
},
{
"name": "groupIds",
"description": "The array of group IDs to set for the segment",
"description": "The array of group IDs to set for the segment.",
"type": {
"kind": "LIST",
"name": null,
......@@ -12536,7 +12536,7 @@
},
{
"name": "segment",
"description": "The segment after mutation",
"description": "The segment after mutation.",
"args": [
],
......@@ -12704,7 +12704,7 @@
"inputFields": [
{
"name": "groupPath",
"description": "The group the epic to mutate is in",
"description": "The group the epic to mutate is in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -12718,7 +12718,7 @@
},
{
"name": "title",
"description": "The title of the epic",
"description": "The title of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -12728,7 +12728,7 @@
},
{
"name": "description",
"description": "The description of the epic",
"description": "The description of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -12738,7 +12738,7 @@
},
{
"name": "confidential",
"description": "Indicates if the epic is confidential",
"description": "Indicates if the epic is confidential.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -12748,7 +12748,7 @@
},
{
"name": "startDateFixed",
"description": "The start date of the epic",
"description": "The start date of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -12758,7 +12758,7 @@
},
{
"name": "dueDateFixed",
"description": "The end date of the epic",
"description": "The end date of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -12768,7 +12768,7 @@
},
{
"name": "startDateIsFixed",
"description": "Indicates start date should be sourced from start_date_fixed field not the issue milestones",
"description": "Indicates start date should be sourced from start_date_fixed field not the issue milestones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -12778,7 +12778,7 @@
},
{
"name": "dueDateIsFixed",
"description": "Indicates end date should be sourced from due_date_fixed field not the issue milestones",
"description": "Indicates end date should be sourced from due_date_fixed field not the issue milestones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -12858,7 +12858,7 @@
},
{
"name": "epic",
"description": "The created epic",
"description": "The created epic.",
"args": [
],
......@@ -13224,7 +13224,7 @@
},
{
"name": "healthStatus",
"description": "The desired health status",
"description": "The desired health status.",
"type": {
"kind": "ENUM",
"name": "HealthStatus",
......@@ -13234,7 +13234,7 @@
},
{
"name": "weight",
"description": "The weight of the issue",
"description": "The weight of the issue.",
"type": {
"kind": "SCALAR",
"name": "Int",
......@@ -13244,7 +13244,7 @@
},
{
"name": "epicId",
"description": "The ID of an epic to associate the issue with",
"description": "The ID of an epic to associate the issue with.",
"type": {
"kind": "SCALAR",
"name": "EpicID",
......@@ -13342,7 +13342,7 @@
"inputFields": [
{
"name": "groupPath",
"description": "The target group for the iteration",
"description": "The target group for the iteration.",
"type": {
"kind": "SCALAR",
"name": "ID",
......@@ -13352,7 +13352,7 @@
},
{
"name": "projectPath",
"description": "The target project for the iteration",
"description": "The target project for the iteration.",
"type": {
"kind": "SCALAR",
"name": "ID",
......@@ -13362,7 +13362,7 @@
},
{
"name": "title",
"description": "The title of the iteration",
"description": "The title of the iteration.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13372,7 +13372,7 @@
},
{
"name": "description",
"description": "The description of the iteration",
"description": "The description of the iteration.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13382,7 +13382,7 @@
},
{
"name": "startDate",
"description": "The start date of the iteration",
"description": "The start date of the iteration.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13392,7 +13392,7 @@
},
{
"name": "dueDate",
"description": "The end date of the iteration",
"description": "The end date of the iteration.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13462,7 +13462,7 @@
},
{
"name": "iteration",
"description": "The created iteration",
"description": "The created iteration.",
"args": [
],
......@@ -13626,7 +13626,7 @@
"inputFields": [
{
"name": "title",
"description": "Title of the requirement",
"description": "Title of the requirement.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13636,7 +13636,7 @@
},
{
"name": "description",
"description": "Description of the requirement",
"description": "Description of the requirement.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13646,7 +13646,7 @@
},
{
"name": "projectPath",
"description": "Full project path the requirement is associated with",
"description": "Full project path the requirement is associated with.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -13720,7 +13720,7 @@
},
{
"name": "requirement",
"description": "Requirement after mutation",
"description": "Requirement after mutation.",
"args": [
],
......@@ -13934,7 +13934,7 @@
"inputFields": [
{
"name": "title",
"description": "The test case title",
"description": "The test case title.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -13948,7 +13948,7 @@
},
{
"name": "description",
"description": "The test case description",
"description": "The test case description.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13976,7 +13976,7 @@
},
{
"name": "projectPath",
"description": "The project full path to create the test case",
"description": "The project full path to create the test case.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -14050,7 +14050,7 @@
},
{
"name": "testCase",
"description": "The test case created",
"description": "The test case created.",
"args": [
],
......@@ -16699,7 +16699,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the segment",
"description": "ID of the segment.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -19449,7 +19449,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the compliance framework to destroy",
"description": "The global ID of the compliance framework to destroy.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -21606,7 +21606,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be dismissed",
"description": "ID of the vulnerability to be dismissed.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -21620,7 +21620,7 @@
},
{
"name": "comment",
"description": "Comment why vulnerability should be dismissed",
"description": "Comment why vulnerability should be dismissed.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -21630,7 +21630,7 @@
},
{
"name": "dismissalReason",
"description": "Reason why vulnerability should be dismissed",
"description": "Reason why vulnerability should be dismissed.",
"type": {
"kind": "ENUM",
"name": "VulnerabilityDismissalReason",
......@@ -21700,7 +21700,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after dismissal",
"description": "The vulnerability after dismissal.",
"args": [
],
......@@ -23408,7 +23408,7 @@
"inputFields": [
{
"name": "iid",
"description": "The IID of the epic to mutate",
"description": "The IID of the epic to mutate.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -23422,7 +23422,7 @@
},
{
"name": "groupPath",
"description": "The group the epic to mutate belongs to",
"description": "The group the epic to mutate belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -23436,7 +23436,7 @@
},
{
"name": "projectPath",
"description": "The full path of the project the issue belongs to",
"description": "The full path of the project the issue belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -23450,7 +23450,7 @@
},
{
"name": "issueIid",
"description": "The IID of the issue to be added",
"description": "The IID of the issue to be added.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -23498,7 +23498,7 @@
},
{
"name": "epic",
"description": "The epic after mutation",
"description": "The epic after mutation.",
"args": [
],
......@@ -23512,7 +23512,7 @@
},
{
"name": "epicIssue",
"description": "The epic-issue relation",
"description": "The epic-issue relation.",
"args": [
],
......@@ -25809,7 +25809,7 @@
"inputFields": [
{
"name": "iid",
"description": "The IID of the epic to mutate",
"description": "The IID of the epic to mutate.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -25823,7 +25823,7 @@
},
{
"name": "groupPath",
"description": "The group the epic to mutate belongs to",
"description": "The group the epic to mutate belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -25837,7 +25837,7 @@
},
{
"name": "subscribedState",
"description": "The desired state of the subscription",
"description": "The desired state of the subscription.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -25885,7 +25885,7 @@
},
{
"name": "epic",
"description": "The epic after mutation",
"description": "The epic after mutation.",
"args": [
],
......@@ -26081,7 +26081,7 @@
"inputFields": [
{
"name": "baseEpicId",
"description": "The ID of the base epic of the tree",
"description": "The ID of the base epic of the tree.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -26095,7 +26095,7 @@
},
{
"name": "moved",
"description": "Parameters for updating the tree positions",
"description": "Parameters for updating the tree positions.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -33451,7 +33451,7 @@
},
{
"name": "epicId",
"description": "The ID of the parent epic. NULL when removing the association",
"description": "The ID of the parent epic. NULL when removing the association.",
"type": {
"kind": "SCALAR",
"name": "EpicID",
......@@ -34851,7 +34851,7 @@
},
{
"name": "weight",
"description": "The desired weight for the issue",
"description": "The desired weight for the issue.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46545,7 +46545,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the namespace to mutate",
"description": "The global ID of the namespace to mutate.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46619,7 +46619,7 @@
},
{
"name": "namespace",
"description": "The namespace after mutation",
"description": "The namespace after mutation.",
"args": [
],
......@@ -47970,7 +47970,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "The project to create the on-call schedule in",
"description": "The project to create the on-call schedule in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -47984,7 +47984,7 @@
},
{
"name": "name",
"description": "The name of the on-call schedule",
"description": "The name of the on-call schedule.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -47998,7 +47998,7 @@
},
{
"name": "description",
"description": "The description of the on-call schedule",
"description": "The description of the on-call schedule.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -48008,7 +48008,7 @@
},
{
"name": "timezone",
"description": "The timezone of the on-call schedule",
"description": "The timezone of the on-call schedule.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -48082,7 +48082,7 @@
},
{
"name": "oncallSchedule",
"description": "The on-call schedule",
"description": "The on-call schedule.",
"args": [
],
......@@ -48110,7 +48110,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "The project to remove the on-call schedule from",
"description": "The project to remove the on-call schedule from.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -48124,7 +48124,7 @@
},
{
"name": "iid",
"description": "The on-call schedule internal ID to remove",
"description": "The on-call schedule internal ID to remove.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -48198,7 +48198,7 @@
},
{
"name": "oncallSchedule",
"description": "The on-call schedule",
"description": "The on-call schedule.",
"args": [
],
......@@ -48226,7 +48226,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "The project to update the on-call schedule in",
"description": "The project to update the on-call schedule in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -48240,7 +48240,7 @@
},
{
"name": "iid",
"description": "The on-call schedule internal ID to update",
"description": "The on-call schedule internal ID to update.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -48254,7 +48254,7 @@
},
{
"name": "name",
"description": "The name of the on-call schedule",
"description": "The name of the on-call schedule.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -48264,7 +48264,7 @@
},
{
"name": "description",
"description": "The description of the on-call schedule",
"description": "The description of the on-call schedule.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -48274,7 +48274,7 @@
},
{
"name": "timezone",
"description": "The timezone of the on-call schedule",
"description": "The timezone of the on-call schedule.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -48344,7 +48344,7 @@
},
{
"name": "oncallSchedule",
"description": "The on-call schedule",
"description": "The on-call schedule.",
"args": [
],
......@@ -56838,7 +56838,7 @@
},
{
"name": "groupPath",
"description": "The group the promoted epic will belong to",
"description": "The group the promoted epic will belong to.",
"type": {
"kind": "SCALAR",
"name": "ID",
......@@ -56882,7 +56882,7 @@
},
{
"name": "epic",
"description": "The epic after issue promotion",
"description": "The epic after issue promotion.",
"args": [
],
......@@ -60282,7 +60282,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the project to remove from the Instance Security Dashboard",
"description": "ID of the project to remove from the Instance Security Dashboard.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -61261,7 +61261,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be reverted",
"description": "ID of the vulnerability to be reverted.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -61335,7 +61335,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after revert",
"description": "The vulnerability after revert.",
"args": [
],
......@@ -70819,7 +70819,7 @@
"inputFields": [
{
"name": "boardId",
"description": "The board global ID",
"description": "The board global ID.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -70833,7 +70833,7 @@
},
{
"name": "epicId",
"description": "ID of an epic to set preferences for",
"description": "ID of an epic to set preferences for.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -70847,7 +70847,7 @@
},
{
"name": "collapsed",
"description": "Whether the epic should be collapsed in the board",
"description": "Whether the epic should be collapsed in the board.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -70895,7 +70895,7 @@
},
{
"name": "epicUserPreferences",
"description": "User preferences for the epic in the board after mutation",
"description": "User preferences for the epic in the board after mutation.",
"args": [
],
......@@ -71557,7 +71557,7 @@
"inputFields": [
{
"name": "name",
"description": "Name of the segment",
"description": "Name of the segment.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71571,7 +71571,7 @@
},
{
"name": "groupIds",
"description": "The array of group IDs to set for the segment",
"description": "The array of group IDs to set for the segment.",
"type": {
"kind": "LIST",
"name": null,
......@@ -71589,7 +71589,7 @@
},
{
"name": "id",
"description": "ID of the segment",
"description": "ID of the segment.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71663,7 +71663,7 @@
},
{
"name": "segment",
"description": "The segment after mutation",
"description": "The segment after mutation.",
"args": [
],
......@@ -71742,7 +71742,7 @@
"inputFields": [
{
"name": "iid",
"description": "The IID of the epic to mutate",
"description": "The IID of the epic to mutate.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71756,7 +71756,7 @@
},
{
"name": "groupPath",
"description": "The group the epic to mutate is in",
"description": "The group the epic to mutate is in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71770,7 +71770,7 @@
},
{
"name": "title",
"description": "The title of the epic",
"description": "The title of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -71780,7 +71780,7 @@
},
{
"name": "description",
"description": "The description of the epic",
"description": "The description of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -71790,7 +71790,7 @@
},
{
"name": "confidential",
"description": "Indicates if the epic is confidential",
"description": "Indicates if the epic is confidential.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -71800,7 +71800,7 @@
},
{
"name": "startDateFixed",
"description": "The start date of the epic",
"description": "The start date of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -71810,7 +71810,7 @@
},
{
"name": "dueDateFixed",
"description": "The end date of the epic",
"description": "The end date of the epic.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -71820,7 +71820,7 @@
},
{
"name": "startDateIsFixed",
"description": "Indicates start date should be sourced from start_date_fixed field not the issue milestones",
"description": "Indicates start date should be sourced from start_date_fixed field not the issue milestones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -71830,7 +71830,7 @@
},
{
"name": "dueDateIsFixed",
"description": "Indicates end date should be sourced from due_date_fixed field not the issue milestones",
"description": "Indicates end date should be sourced from due_date_fixed field not the issue milestones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -71876,7 +71876,7 @@
},
{
"name": "stateEvent",
"description": "State event for the epic",
"description": "State event for the epic.",
"type": {
"kind": "ENUM",
"name": "EpicStateEvent",
......@@ -71920,7 +71920,7 @@
},
{
"name": "epic",
"description": "The epic after mutation",
"description": "The epic after mutation.",
"args": [
],
......@@ -72230,7 +72230,7 @@
},
{
"name": "healthStatus",
"description": "The desired health status",
"description": "The desired health status.",
"type": {
"kind": "ENUM",
"name": "HealthStatus",
......@@ -72240,7 +72240,7 @@
},
{
"name": "weight",
"description": "The weight of the issue",
"description": "The weight of the issue.",
"type": {
"kind": "SCALAR",
"name": "Int",
......@@ -72250,7 +72250,7 @@
},
{
"name": "epicId",
"description": "The ID of the parent epic. NULL when removing the association",
"description": "The ID of the parent epic. NULL when removing the association.",
"type": {
"kind": "SCALAR",
"name": "EpicID",
......@@ -72748,7 +72748,7 @@
"inputFields": [
{
"name": "title",
"description": "Title of the requirement",
"description": "Title of the requirement.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -72758,7 +72758,7 @@
},
{
"name": "description",
"description": "Description of the requirement",
"description": "Description of the requirement.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -72768,7 +72768,7 @@
},
{
"name": "projectPath",
"description": "Full project path the requirement is associated with",
"description": "Full project path the requirement is associated with.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -72782,7 +72782,7 @@
},
{
"name": "state",
"description": "State of the requirement",
"description": "State of the requirement.",
"type": {
"kind": "ENUM",
"name": "RequirementState",
......@@ -72792,7 +72792,7 @@
},
{
"name": "iid",
"description": "The IID of the requirement to update",
"description": "The IID of the requirement to update.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -72806,7 +72806,7 @@
},
{
"name": "lastTestReportState",
"description": "Creates a test report for the requirement with the given state",
"description": "Creates a test report for the requirement with the given state.",
"type": {
"kind": "ENUM",
"name": "TestReportState",
......@@ -72876,7 +72876,7 @@
},
{
"name": "requirement",
"description": "Requirement after mutation",
"description": "Requirement after mutation.",
"args": [
],
......@@ -75753,7 +75753,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be confirmed",
"description": "ID of the vulnerability to be confirmed.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -75827,7 +75827,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after state change",
"description": "The vulnerability after state change.",
"args": [
],
......@@ -75922,7 +75922,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be dismissed",
"description": "ID of the vulnerability to be dismissed.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -75936,7 +75936,7 @@
},
{
"name": "comment",
"description": "Comment why vulnerability should be dismissed",
"description": "Comment why vulnerability should be dismissed.",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -75946,7 +75946,7 @@
},
{
"name": "dismissalReason",
"description": "Reason why vulnerability should be dismissed",
"description": "Reason why vulnerability should be dismissed.",
"type": {
"kind": "ENUM",
"name": "VulnerabilityDismissalReason",
......@@ -76016,7 +76016,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after dismissal",
"description": "The vulnerability after dismissal.",
"args": [
],
......@@ -77562,7 +77562,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be resolved",
"description": "ID of the vulnerability to be resolved.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -77636,7 +77636,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after state change",
"description": "The vulnerability after state change.",
"args": [
],
......@@ -77664,7 +77664,7 @@
"inputFields": [
{
"name": "id",
"description": "ID of the vulnerability to be reverted",
"description": "ID of the vulnerability to be reverted.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -77738,7 +77738,7 @@
},
{
"name": "vulnerability",
"description": "The vulnerability after revert",
"description": "The vulnerability after revert.",
"args": [
],
doc/api/graphql/reference/index.md
View file @ c64366eb
......@@ -62,7 +62,7 @@ Autogenerated return type of AddProjectToSecurityDashboard.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `project` | Project | Project that was added to the Instance Security Dashboard |
| `project` | Project | Project that was added to the Instance Security Dashboard. |
### AdminSidekiqQueuesDeleteJobsPayload
......@@ -356,7 +356,7 @@ Autogenerated return type of BoardListUpdateLimitMetrics.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | The updated list |
| `list` | BoardList | The updated list. |
### Branch
......@@ -493,8 +493,8 @@ Autogenerated return type of ClusterAgentTokenCreate.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `secret` | String | Token secret value. Make sure you save it - you won't be able to access it again |
| `token` | ClusterAgentToken | Token created after mutation |
| `secret` | String | Token secret value. Make sure you save it - you won't be able to access it again. |
| `token` | ClusterAgentToken | Token created after mutation. |
### ClusterAgentTokenDeletePayload
......@@ -576,8 +576,8 @@ Autogenerated return type of ConfigureSast.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `status` | String! | Status of creating the commit for the supplied SAST CI configuration |
| `successPath` | String | Redirect path to use when the response is successful |
| `status` | String! | Status of creating the commit for the supplied SAST CI configuration. |
| `successPath` | String | Redirect path to use when the response is successful. |
### ContainerExpirationPolicy
......@@ -699,7 +699,7 @@ Autogenerated return type of CreateClusterAgent.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `clusterAgent` | ClusterAgent | Cluster agent created after mutation |
| `clusterAgent` | ClusterAgent | Cluster agent created after mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### CreateComplianceFrameworkPayload
......@@ -730,7 +730,7 @@ Autogenerated return type of CreateDevopsAdoptionSegment.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `segment` | DevopsAdoptionSegment | The segment after mutation |
| `segment` | DevopsAdoptionSegment | The segment after mutation. |
### CreateDiffNotePayload
......@@ -749,7 +749,7 @@ Autogenerated return type of CreateEpic.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The created epic |
| `epic` | Epic | The created epic. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### CreateImageDiffNotePayload
......@@ -780,7 +780,7 @@ Autogenerated return type of CreateIteration.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `iteration` | Iteration | The created iteration |
| `iteration` | Iteration | The created iteration. |
### CreateNotePayload
......@@ -800,7 +800,7 @@ Autogenerated return type of CreateRequirement.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `requirement` | Requirement | Requirement after mutation |
| `requirement` | Requirement | Requirement after mutation. |
### CreateSnippetPayload
......@@ -821,7 +821,7 @@ Autogenerated return type of CreateTestCase.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `testCase` | Issue | The test case created |
| `testCase` | Issue | The test case created. |
### CustomEmoji
......@@ -1294,7 +1294,7 @@ Autogenerated return type of DismissVulnerability.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after dismissal |
| `vulnerability` | Vulnerability | The vulnerability after dismissal. |
### Environment
......@@ -1376,8 +1376,8 @@ Autogenerated return type of EpicAddIssue.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epicIssue` | EpicIssue | The epic-issue relation |
| `epic` | Epic | The epic after mutation. |
| `epicIssue` | EpicIssue | The epic-issue relation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### EpicBoard
......@@ -1518,7 +1518,7 @@ Autogenerated return type of EpicSetSubscription.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epic` | Epic | The epic after mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### EpicTreeReorderPayload
......@@ -2373,7 +2373,7 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `namespace` | Namespace | The namespace after mutation |
| `namespace` | Namespace | The namespace after mutation. |
### Note
......@@ -2437,7 +2437,7 @@ Autogenerated return type of OncallScheduleCreate.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
### OncallScheduleDestroyPayload
......@@ -2447,7 +2447,7 @@ Autogenerated return type of OncallScheduleDestroy.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
### OncallScheduleUpdatePayload
......@@ -2457,7 +2457,7 @@ Autogenerated return type of OncallScheduleUpdate.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
### Package
......@@ -2830,7 +2830,7 @@ Autogenerated return type of PromoteToEpic.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after issue promotion |
| `epic` | Epic | The epic after issue promotion. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation. |
......@@ -3029,7 +3029,7 @@ Autogenerated return type of RevertVulnerabilityToDetected.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after revert |
| `vulnerability` | Vulnerability | The vulnerability after revert. |
### RootStorageStatistics
......@@ -3638,7 +3638,7 @@ Autogenerated return type of UpdateBoardEpicUserPreferences.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epicUserPreferences` | BoardEpicUserPreferences | User preferences for the epic in the board after mutation |
| `epicUserPreferences` | BoardEpicUserPreferences | User preferences for the epic in the board after mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### UpdateBoardListPayload
......@@ -3689,7 +3689,7 @@ Autogenerated return type of UpdateDevopsAdoptionSegment.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `segment` | DevopsAdoptionSegment | The segment after mutation |
| `segment` | DevopsAdoptionSegment | The segment after mutation. |
### UpdateEpicPayload
......@@ -3698,7 +3698,7 @@ Autogenerated return type of UpdateEpic.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epic` | Epic | The epic after mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
### UpdateImageDiffNotePayload
......@@ -3759,7 +3759,7 @@ Autogenerated return type of UpdateRequirement.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `requirement` | Requirement | Requirement after mutation |
| `requirement` | Requirement | Requirement after mutation. |
### UpdateSnippetPayload
......@@ -3881,7 +3881,7 @@ Autogenerated return type of VulnerabilityConfirm.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after state change |
| `vulnerability` | Vulnerability | The vulnerability after state change. |
### VulnerabilityDismissPayload
......@@ -3891,7 +3891,7 @@ Autogenerated return type of VulnerabilityDismiss.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after dismissal |
| `vulnerability` | Vulnerability | The vulnerability after dismissal. |
### VulnerabilityExternalIssueLink
......@@ -4033,7 +4033,7 @@ Autogenerated return type of VulnerabilityResolve.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after state change |
| `vulnerability` | Vulnerability | The vulnerability after state change. |
### VulnerabilityRevertToDetectedPayload
......@@ -4043,7 +4043,7 @@ Autogenerated return type of VulnerabilityRevertToDetected.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after revert |
| `vulnerability` | Vulnerability | The vulnerability after revert. |
### VulnerabilityScanner
......
ee/app/graphql/ee/mutations/boards/issues/issue_move_list.rb
View file @ c64366eb
......@@ -13,7 +13,7 @@ module EE
prepended do
argument :epic_id, EpicID,
required: false,
description: 'The ID of the parent epic. NULL when removing the association'
description: 'The ID of the parent epic. NULL when removing the association.'
end
override :move_issue
......
ee/app/graphql/ee/mutations/boards/lists/create.rb
View file @ c64366eb
......@@ -11,13 +11,13 @@ module EE
prepended do
argument :milestone_id, ::Types::GlobalIDType[::Milestone],
required: false,
description: 'Global ID of an existing milestone'
description: 'Global ID of an existing milestone.'
argument :iteration_id, ::Types::GlobalIDType[::Iteration],
required: false,
description: 'Global ID of an existing iteration'
description: 'Global ID of an existing iteration.'
argument :assignee_id, ::Types::GlobalIDType[::User],
required: false,
description: 'Global ID of an existing user'
description: 'Global ID of an existing user.'
end
private
......
ee/app/graphql/ee/mutations/issues/create.rb
View file @ c64366eb
......@@ -11,7 +11,7 @@ module EE
argument :epic_id, ::Types::GlobalIDType[::Epic],
required: false,
description: 'The ID of an epic to associate the issue with'
description: 'The ID of an epic to associate the issue with.'
end
private
......
ee/app/graphql/ee/mutations/issues/update.rb
View file @ c64366eb
......@@ -12,7 +12,7 @@ module EE
argument :epic_id, ::Types::GlobalIDType[::Epic],
required: false,
loads: ::Types::EpicType,
description: 'The ID of the parent epic. NULL when removing the association'
description: 'The ID of the parent epic. NULL when removing the association.'
end
def resolve(**args)
......
ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/delete.rb
View file @ c64366eb
......@@ -12,7 +12,7 @@ module Mutations
argument :id, ::Types::GlobalIDType[::Analytics::DevopsAdoption::Segment],
required: true,
description: "ID of the segment"
description: "ID of the segment."
def resolve(id:, **)
response = ::Analytics::DevopsAdoption::Segments::DeleteService
......
ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/mixins.rb
View file @ c64366eb
......@@ -41,16 +41,16 @@ module Mutations
included do
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'Name of the segment'
description: 'Name of the segment.'
argument :group_ids, [::Types::GlobalIDType[::Group]],
required: false,
description: 'The array of group IDs to set for the segment'
description: 'The array of group IDs to set for the segment.'
field :segment,
Types::Admin::Analytics::DevopsAdoption::SegmentType,
null: true,
description: 'The segment after mutation'
description: 'The segment after mutation.'
end
end
end
......
ee/app/graphql/mutations/admin/analytics/devops_adoption/segments/update.rb
View file @ c64366eb
......@@ -13,7 +13,7 @@ module Mutations
argument :id, ::Types::GlobalIDType[::Analytics::DevopsAdoption::Segment],
required: true,
description: "ID of the segment"
description: "ID of the segment."
def resolve(id:, name:, group_ids: nil, **)
groups = GlobalID::Locator.locate_many(group_ids) if group_ids
......
ee/app/graphql/mutations/boards/lists/update_limit_metrics.rb
View file @ c64366eb
......@@ -29,7 +29,7 @@ module Mutations
field :list,
::Types::BoardListType,
null: true,
description: 'The updated list'
description: 'The updated list.'
def ready?(**args)
if limit_metric_settings_of(args).blank?
......
ee/app/graphql/mutations/boards/update_epic_user_preferences.rb
View file @ c64366eb
......@@ -8,22 +8,22 @@ module Mutations
argument :board_id,
::Types::GlobalIDType[::Board],
required: true,
description: 'The board global ID'
description: 'The board global ID.'
argument :epic_id,
::Types::GlobalIDType[::Epic],
required: true,
description: 'ID of an epic to set preferences for'
description: 'ID of an epic to set preferences for.'
argument :collapsed,
GraphQL::BOOLEAN_TYPE,
required: true,
description: 'Whether the epic should be collapsed in the board'
description: 'Whether the epic should be collapsed in the board.'
field :epic_user_preferences,
Types::Boards::EpicUserPreferencesType,
null: true,
description: 'User preferences for the epic in the board after mutation'
description: 'User preferences for the epic in the board after mutation.'
authorize :read_board
......
ee/app/graphql/mutations/clusters/agent_tokens/create.rb
View file @ c64366eb
......@@ -12,17 +12,17 @@ module Mutations
argument :cluster_agent_id, ClusterAgentID,
required: true,
description: 'Global ID of the cluster agent that will be associated with the new token'
description: 'Global ID of the cluster agent that will be associated with the new token.'
field :secret,
GraphQL::STRING_TYPE,
null: true,
description: "Token secret value. Make sure you save it - you won't be able to access it again"
description: "Token secret value. Make sure you save it - you won't be able to access it again."
field :token,
Types::Clusters::AgentTokenType,
null: true,
description: 'Token created after mutation'
description: 'Token created after mutation.'
def resolve(cluster_agent_id:)
cluster_agent = authorized_find!(id: cluster_agent_id)
......
ee/app/graphql/mutations/clusters/agent_tokens/delete.rb
View file @ c64366eb
......@@ -12,7 +12,7 @@ module Mutations
argument :id, TokenID,
required: true,
description: 'Global ID of the cluster agent token that will be deleted'
description: 'Global ID of the cluster agent token that will be deleted.'
def resolve(id:)
token = authorized_find!(id: id)
......
ee/app/graphql/mutations/clusters/agents/create.rb
View file @ c64366eb
......@@ -12,16 +12,16 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full path of the associated project for this cluster agent'
description: 'Full path of the associated project for this cluster agent.'
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'Name of the cluster agent'
description: 'Name of the cluster agent.'
field :cluster_agent,
Types::Clusters::AgentType,
null: true,
description: 'Cluster agent created after mutation'
description: 'Cluster agent created after mutation.'
def resolve(project_path:, name:)
project = authorized_find!(full_path: project_path)
......
ee/app/graphql/mutations/clusters/agents/delete.rb
View file @ c64366eb
......@@ -12,7 +12,7 @@ module Mutations
argument :id, AgentID,
required: true,
description: 'Global ID of the cluster agent that will be deleted'
description: 'Global ID of the cluster agent that will be deleted.'
def resolve(id:)
cluster_agent = authorized_find!(id: id)
......
ee/app/graphql/mutations/compliance_management/frameworks/destroy.rb
View file @ c64366eb
......@@ -11,7 +11,7 @@ module Mutations
argument :id,
::Types::GlobalIDType[::ComplianceManagement::Framework],
required: true,
description: 'The global ID of the compliance framework to destroy'
description: 'The global ID of the compliance framework to destroy.'
def resolve(id:)
framework = authorized_find!(id: id)
......
ee/app/graphql/mutations/concerns/mutations/shared_epic_arguments.rb
View file @ c64366eb
......@@ -7,42 +7,42 @@ module Mutations
prepended do
argument :group_path, GraphQL::ID_TYPE,
required: true,
description: "The group the epic to mutate is in"
description: "The group the epic to mutate is in."
argument :title,
GraphQL::STRING_TYPE,
required: false,
description: 'The title of the epic'
description: 'The title of the epic.'
argument :description,
GraphQL::STRING_TYPE,
required: false,
description: 'The description of the epic'
description: 'The description of the epic.'
argument :confidential,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates if the epic is confidential'
description: 'Indicates if the epic is confidential.'
argument :start_date_fixed,
GraphQL::STRING_TYPE,
required: false,
description: 'The start date of the epic'
description: 'The start date of the epic.'
argument :due_date_fixed,
GraphQL::STRING_TYPE,
required: false,
description: 'The end date of the epic'
description: 'The end date of the epic.'
argument :start_date_is_fixed,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates start date should be sourced from start_date_fixed field not the issue milestones'
description: 'Indicates start date should be sourced from start_date_fixed field not the issue milestones.'
argument :due_date_is_fixed,
GraphQL::BOOLEAN_TYPE,
required: false,
description: 'Indicates end date should be sourced from due_date_fixed field not the issue milestones'
description: 'Indicates end date should be sourced from due_date_fixed field not the issue milestones.'
argument :add_label_ids,
[GraphQL::ID_TYPE],
required: false,
......
ee/app/graphql/mutations/epic_tree/reorder.rb
View file @ c64366eb
......@@ -10,12 +10,12 @@ module Mutations
argument :base_epic_id,
::Types::GlobalIDType[::Epic],
required: true,
description: 'The ID of the base epic of the tree'
description: 'The ID of the base epic of the tree.'
argument :moved,
Types::EpicTree::EpicTreeNodeInputType,
required: true,
description: 'Parameters for updating the tree positions'
description: 'Parameters for updating the tree positions.'
def resolve(args)
moving_object_id = args[:moved][:id]
......
ee/app/graphql/mutations/epics/add_issue.rb
View file @ c64366eb
......@@ -11,16 +11,16 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The full path of the project the issue belongs to'
description: 'The full path of the project the issue belongs to.'
argument :issue_iid, GraphQL::STRING_TYPE,
required: true,
description: 'The IID of the issue to be added'
description: 'The IID of the issue to be added.'
field :epic_issue,
Types::EpicIssueType,
null: true,
description: 'The epic-issue relation'
description: 'The epic-issue relation.'
def resolve(group_path:, iid:, project_path:, issue_iid:)
epic = authorized_find!(group_path: group_path, iid: iid)
......
ee/app/graphql/mutations/epics/base.rb
View file @ c64366eb
......@@ -7,16 +7,16 @@ module Mutations
argument :iid, GraphQL::ID_TYPE,
required: true,
description: "The IID of the epic to mutate"
description: "The IID of the epic to mutate."
argument :group_path, GraphQL::ID_TYPE,
required: true,
description: 'The group the epic to mutate belongs to'
description: 'The group the epic to mutate belongs to.'
field :epic,
Types::EpicType,
null: true,
description: 'The epic after mutation'
description: 'The epic after mutation.'
private
......
ee/app/graphql/mutations/epics/create.rb
View file @ c64366eb
......@@ -13,7 +13,7 @@ module Mutations
field :epic,
Types::EpicType,
null: true,
description: 'The created epic'
description: 'The created epic.'
def resolve(args)
group_path = args.delete(:group_path)
......
ee/app/graphql/mutations/epics/set_subscription.rb
View file @ c64366eb
......@@ -9,7 +9,7 @@ module Mutations
argument :subscribed_state, GraphQL::BOOLEAN_TYPE,
required: true,
description: 'The desired state of the subscription'
description: 'The desired state of the subscription.'
def resolve(args)
group_path = args.delete(:group_path)
......
ee/app/graphql/mutations/epics/update.rb
View file @ c64366eb
......@@ -10,7 +10,7 @@ module Mutations
argument :state_event,
Types::EpicStateEventEnum,
required: false,
description: 'State event for the epic'
description: 'State event for the epic.'
authorize :admin_epic
......
ee/app/graphql/mutations/incident_management/oncall_schedule/create.rb
View file @ c64366eb
......@@ -10,19 +10,19 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to create the on-call schedule in'
description: 'The project to create the on-call schedule in.'
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'The name of the on-call schedule'
description: 'The name of the on-call schedule.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The description of the on-call schedule'
description: 'The description of the on-call schedule.'
argument :timezone, GraphQL::STRING_TYPE,
required: true,
description: 'The timezone of the on-call schedule'
description: 'The timezone of the on-call schedule.'
def resolve(args)
project = authorized_find!(full_path: args[:project_path])
......
ee/app/graphql/mutations/incident_management/oncall_schedule/destroy.rb
View file @ c64366eb
......@@ -8,11 +8,11 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to remove the on-call schedule from'
description: 'The project to remove the on-call schedule from.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The on-call schedule internal ID to remove'
description: 'The on-call schedule internal ID to remove.'
def resolve(project_path:, iid:)
oncall_schedule = authorized_find!(project_path: project_path, iid: iid)
......
ee/app/graphql/mutations/incident_management/oncall_schedule/oncall_schedule_base.rb
View file @ c64366eb
......@@ -7,7 +7,7 @@ module Mutations
field :oncall_schedule,
::Types::IncidentManagement::OncallScheduleType,
null: true,
description: 'The on-call schedule'
description: 'The on-call schedule.'
authorize :admin_incident_management_oncall_schedule
......
ee/app/graphql/mutations/incident_management/oncall_schedule/update.rb
View file @ c64366eb
......@@ -8,23 +8,23 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to update the on-call schedule in'
description: 'The project to update the on-call schedule in.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The on-call schedule internal ID to update'
description: 'The on-call schedule internal ID to update.'
argument :name, GraphQL::STRING_TYPE,
required: false,
description: 'The name of the on-call schedule'
description: 'The name of the on-call schedule.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The description of the on-call schedule'
description: 'The description of the on-call schedule.'
argument :timezone, GraphQL::STRING_TYPE,
required: false,
description: 'The timezone of the on-call schedule'
description: 'The timezone of the on-call schedule.'
def resolve(args)
oncall_schedule = authorized_find!(project_path: args[:project_path], iid: args[:iid])
......
ee/app/graphql/mutations/instance_security_dashboard/add_project.rb
View file @ c64366eb
......@@ -9,11 +9,11 @@ module Mutations
field :project, Types::ProjectType,
null: true,
description: 'Project that was added to the Instance Security Dashboard'
description: 'Project that was added to the Instance Security Dashboard.'
argument :id, ::Types::GlobalIDType[::Project],
required: true,
description: 'ID of the project to be added to Instance Security Dashboard'
description: 'ID of the project to be added to Instance Security Dashboard.'
def resolve(id:)
project = authorized_find!(id: id)
......
ee/app/graphql/mutations/instance_security_dashboard/remove_project.rb
View file @ c64366eb
......@@ -9,7 +9,7 @@ module Mutations
argument :id, Types::GlobalIDType[::Project],
required: true,
description: 'ID of the project to remove from the Instance Security Dashboard'
description: 'ID of the project to remove from the Instance Security Dashboard.'
def resolve(id:)
dashboard = authorized_find!
......
ee/app/graphql/mutations/issues/common_ee_mutation_arguments.rb
View file @ c64366eb
......@@ -9,11 +9,11 @@ module Mutations
argument :health_status,
::Types::HealthStatusEnum,
required: false,
description: 'The desired health status'
description: 'The desired health status.'
argument :weight, GraphQL::INT_TYPE,
required: false,
description: 'The weight of the issue'
description: 'The weight of the issue.'
end
end
end
......
ee/app/graphql/mutations/issues/promote_to_epic.rb
View file @ c64366eb
......@@ -9,12 +9,12 @@ module Mutations
argument :group_path, GraphQL::ID_TYPE,
required: false,
description: 'The group the promoted epic will belong to'
description: 'The group the promoted epic will belong to.'
field :epic,
Types::EpicType,
null: true,
description: "The epic after issue promotion"
description: "The epic after issue promotion."
def resolve(project_path:, iid:, group_path: nil)
errors = []
......
ee/app/graphql/mutations/issues/set_weight.rb
View file @ c64366eb
......@@ -8,7 +8,7 @@ module Mutations
argument :weight,
GraphQL::INT_TYPE,
required: true,
description: 'The desired weight for the issue'
description: 'The desired weight for the issue.'
def resolve(project_path:, iid:, weight:)
issue = authorized_find!(project_path: project_path, iid: iid)
......
ee/app/graphql/mutations/iterations/create.rb
View file @ c64366eb
......@@ -13,35 +13,35 @@ module Mutations
field :iteration,
Types::IterationType,
null: true,
description: 'The created iteration'
description: 'The created iteration.'
argument :group_path, GraphQL::ID_TYPE,
required: false,
description: "The target group for the iteration"
description: "The target group for the iteration."
argument :project_path, GraphQL::ID_TYPE,
required: false,
description: "The target project for the iteration"
description: "The target project for the iteration."
argument :title,
GraphQL::STRING_TYPE,
required: false,
description: 'The title of the iteration'
description: 'The title of the iteration.'
argument :description,
GraphQL::STRING_TYPE,
required: false,
description: 'The description of the iteration'
description: 'The description of the iteration.'
argument :start_date,
GraphQL::STRING_TYPE,
required: false,
description: 'The start date of the iteration'
description: 'The start date of the iteration.'
argument :due_date,
GraphQL::STRING_TYPE,
required: false,
description: 'The end date of the iteration'
description: 'The end date of the iteration.'
def resolve(args)
validate_arguments!(args)
......
ee/app/graphql/mutations/namespaces/base.rb
View file @ c64366eb
......@@ -5,12 +5,12 @@ module Mutations
class Base < ::Mutations::BaseMutation
argument :id, ::Types::GlobalIDType[::Namespace],
required: true,
description: 'The global ID of the namespace to mutate'
description: 'The global ID of the namespace to mutate.'
field :namespace,
Types::NamespaceType,
null: true,
description: 'The namespace after mutation'
description: 'The namespace after mutation.'
private
......
ee/app/graphql/mutations/quality_management/test_cases/create.rb
View file @ c64366eb
......@@ -12,11 +12,11 @@ module Mutations
argument :title, GraphQL::STRING_TYPE,
required: true,
description: 'The test case title'
description: 'The test case title.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'The test case description'
description: 'The test case description.'
argument :label_ids,
[GraphQL::ID_TYPE],
......@@ -25,11 +25,11 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project full path to create the test case'
description: 'The project full path to create the test case.'
field :test_case, Types::IssueType,
null: true,
description: 'The test case created'
description: 'The test case created.'
def resolve(args)
project_path = args.delete(:project_path)
......
ee/app/graphql/mutations/requirements_management/base_requirement.rb
View file @ c64366eb
......@@ -7,19 +7,19 @@ module Mutations
field :requirement, Types::RequirementsManagement::RequirementType,
null: true,
description: 'Requirement after mutation'
description: 'Requirement after mutation.'
argument :title, GraphQL::STRING_TYPE,
required: false,
description: 'Title of the requirement'
description: 'Title of the requirement.'
argument :description, GraphQL::STRING_TYPE,
required: false,
description: 'Description of the requirement'
description: 'Description of the requirement.'
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full project path the requirement is associated with'
description: 'Full project path the requirement is associated with.'
end
end
end
ee/app/graphql/mutations/requirements_management/update_requirement.rb
View file @ c64366eb
......@@ -9,15 +9,15 @@ module Mutations
argument :state, Types::RequirementsManagement::RequirementStateEnum,
required: false,
description: 'State of the requirement'
description: 'State of the requirement.'
argument :iid, GraphQL::STRING_TYPE,
required: true,
description: 'The IID of the requirement to update'
description: 'The IID of the requirement to update.'
argument :last_test_report_state, Types::RequirementsManagement::TestReportStateEnum,
required: false,
description: 'Creates a test report for the requirement with the given state'
description: 'Creates a test report for the requirement with the given state.'
def ready?(**args)
update_args = [:title, :state, :last_test_report_state, :description]
......
ee/app/graphql/mutations/security/ci_configuration/configure_sast.rb
View file @ c64366eb
......@@ -10,17 +10,17 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'Full path of the project'
description: 'Full path of the project.'
argument :configuration, ::Types::CiConfiguration::Sast::InputType,
required: true,
description: 'SAST CI configuration for the project'
description: 'SAST CI configuration for the project.'
field :status, GraphQL::STRING_TYPE, null: false,
description: 'Status of creating the commit for the supplied SAST CI configuration'
description: 'Status of creating the commit for the supplied SAST CI configuration.'
field :success_path, GraphQL::STRING_TYPE, null: true,
description: 'Redirect path to use when the response is successful'
description: 'Redirect path to use when the response is successful.'
authorize :push_code
......
ee/app/graphql/mutations/vulnerabilities/confirm.rb
View file @ c64366eb
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after state change'
description: 'The vulnerability after state change.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be confirmed'
description: 'ID of the vulnerability to be confirmed.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
ee/app/graphql/mutations/vulnerabilities/dismiss.rb
View file @ c64366eb
......@@ -9,22 +9,22 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after dismissal'
description: 'The vulnerability after dismissal.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be dismissed'
description: 'ID of the vulnerability to be dismissed.'
argument :comment,
GraphQL::STRING_TYPE,
required: false,
description: 'Comment why vulnerability should be dismissed'
description: 'Comment why vulnerability should be dismissed.'
argument :dismissal_reason,
Types::Vulnerabilities::DismissalReasonEnum,
required: false,
description: 'Reason why vulnerability should be dismissed'
description: 'Reason why vulnerability should be dismissed.'
def resolve(id:, comment: nil, dismissal_reason: nil)
vulnerability = authorized_find!(id: id)
......
ee/app/graphql/mutations/vulnerabilities/resolve.rb
View file @ c64366eb
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after state change'
description: 'The vulnerability after state change.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be resolved'
description: 'ID of the vulnerability to be resolved.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
ee/app/graphql/mutations/vulnerabilities/revert_to_detected.rb
View file @ c64366eb
......@@ -9,12 +9,12 @@ module Mutations
field :vulnerability, Types::VulnerabilityType,
null: true,
description: 'The vulnerability after revert'
description: 'The vulnerability after revert.'
argument :id,
::Types::GlobalIDType[::Vulnerability],
required: true,
description: 'ID of the vulnerability to be reverted'
description: 'ID of the vulnerability to be reverted.'
def resolve(id:)
vulnerability = authorized_find!(id: id)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7