Skip to content

G
gitlab-ce
Commit 2a077531 authored by Peter Leitzen's avatar Peter Leitzen
Browse files
Options

Merge branch 'georgekoltsov/update-epic-type-rubocop' into 'master' 

Add dot to GraphQL descriptions of epic_type.rb

See merge request gitlab-org/gitlab!53228
parents b027a297 054eaa0c
Hide whitespace changes
Inline Side-by-side
Showing with 292 additions and 293 deletions
.rubocop_manual_todo.yml
View file @ 2a077531
......@@ -804,7 +804,6 @@ Graphql/Descriptions:
- 'ee/app/graphql/types/epic_health_status_type.rb'
- 'ee/app/graphql/types/epic_issue_type.rb'
- 'ee/app/graphql/types/epic_tree/epic_tree_node_input_type.rb'
- 'ee/app/graphql/types/epic_type.rb'
- 'ee/app/graphql/types/external_issue_type.rb'
- 'ee/app/graphql/types/geo/geo_node_type.rb'
- 'ee/app/graphql/types/geo/merge_request_diff_registry_type.rb'
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ 2a077531
......@@ -1571,12 +1571,12 @@ Represents an epic on an issue board
"""
type BoardEpic implements CurrentUserTodos & Noteable {
"""
Author of the epic
Author of the epic.
"""
author: User!
"""
A list of award emojis associated with the epic
A list of award emojis associated with the epic.
"""
awardEmoji(
"""
......@@ -1601,7 +1601,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): AwardEmojiConnection
"""
Children (sub-epics) of the epic
Children (sub-epics) of the epic.
"""
children(
"""
......@@ -1699,17 +1699,17 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): EpicConnection
"""
Timestamp of when the epic was closed
Timestamp of when the epic was closed.
"""
closedAt: Time
"""
Indicates if the epic is confidential
Indicates if the epic is confidential.
"""
confidential: Boolean
"""
Timestamp of when the epic was created
Timestamp of when the epic was created.
"""
createdAt: Time
......@@ -1744,17 +1744,17 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): TodoConnection!
"""
Number of open and closed descendant epics and issues
Number of open and closed descendant epics and issues.
"""
descendantCounts: EpicDescendantCount
"""
Total weight of open and closed issues in the epic and its descendants
Total weight of open and closed issues in the epic and its descendants.
"""
descendantWeightSum: EpicDescendantWeights
"""
Description of the epic
Description of the epic.
"""
description: String
......@@ -1784,67 +1784,67 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): DiscussionConnection!
"""
Number of downvotes the epic has received
Number of downvotes the epic has received.
"""
downvotes: Int!
"""
Due date of the epic
Due date of the epic.
"""
dueDate: Time
"""
Fixed due date of the epic
Fixed due date of the epic.
"""
dueDateFixed: Time
"""
Inherited due date of the epic from milestones
Inherited due date of the epic from milestones.
"""
dueDateFromMilestones: Time
"""
Indicates if the due date has been manually set
Indicates if the due date has been manually set.
"""
dueDateIsFixed: Boolean
"""
Group to which the epic belongs
Group to which the epic belongs.
"""
group: Group!
"""
Indicates if the epic has children
Indicates if the epic has children.
"""
hasChildren: Boolean!
"""
Indicates if the epic has direct issues
Indicates if the epic has direct issues.
"""
hasIssues: Boolean!
"""
Indicates if the epic has a parent epic
Indicates if the epic has a parent epic.
"""
hasParent: Boolean!
"""
Current health status of the epic
Current health status of the epic.
"""
healthStatus: EpicHealthStatus
"""
ID of the epic
ID of the epic.
"""
id: ID!
"""
Internal ID of the epic
Internal ID of the epic.
"""
iid: ID!
"""
A list of issues associated with the epic
A list of issues associated with the epic.
"""
issues(
"""
......@@ -1869,7 +1869,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): EpicIssueConnection
"""
Labels assigned to the epic
Labels assigned to the epic.
"""
labels(
"""
......@@ -1919,12 +1919,12 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): NoteConnection!
"""
Parent epic of the epic
Parent epic of the epic.
"""
parent: Epic
"""
List of participants for the epic
List of participants for the epic.
"""
participants(
"""
......@@ -1949,77 +1949,77 @@ type BoardEpic implements CurrentUserTodos & Noteable {
): UserConnection
"""
Internal reference of the epic. Returned in shortened format by default
Internal reference of the epic. Returned in shortened format by default.
"""
reference(
"""
Indicates if the reference should be returned in full
Indicates if the reference should be returned in full.
"""
full: Boolean = false
): String!
"""
URI path of the epic-issue relationship
URI path of the epic-issue relationship.
"""
relationPath: String
"""
The relative position of the epic in the epic tree
The relative position of the epic in the epic tree.
"""
relativePosition: Int
"""
Start date of the epic
Start date of the epic.
"""
startDate: Time
"""
Fixed start date of the epic
Fixed start date of the epic.
"""
startDateFixed: Time
"""
Inherited start date of the epic from milestones
Inherited start date of the epic from milestones.
"""
startDateFromMilestones: Time
"""
Indicates if the start date has been manually set
Indicates if the start date has been manually set.
"""
startDateIsFixed: Boolean
"""
State of the epic
State of the epic.
"""
state: EpicState!
"""
Indicates the currently logged in user is subscribed to the epic
Indicates the currently logged in user is subscribed to the epic.
"""
subscribed: Boolean!
"""
Title of the epic
Title of the epic.
"""
title: String
"""
Timestamp of when the epic was updated
Timestamp of when the epic was updated.
"""
updatedAt: Time
"""
Number of upvotes the epic has received
Number of upvotes the epic has received.
"""
upvotes: Int!
"""
Number of user discussions in the epic
Number of user discussions in the epic.
"""
userDiscussionsCount: Int!
"""
Number of user notes of the epic
Number of user notes of the epic.
"""
userNotesCount: Int!
......@@ -2034,12 +2034,12 @@ type BoardEpic implements CurrentUserTodos & Noteable {
userPreferences: BoardEpicUserPreferences
"""
Web path of the epic
Web path of the epic.
"""
webPath: String!
"""
Web URL of the epic
Web URL of the epic.
"""
webUrl: String!
}
......@@ -8417,12 +8417,12 @@ Represents an epic
"""
type Epic implements CurrentUserTodos & Noteable {
"""
Author of the epic
Author of the epic.
"""
author: User!
"""
A list of award emojis associated with the epic
A list of award emojis associated with the epic.
"""
awardEmoji(
"""
......@@ -8447,7 +8447,7 @@ type Epic implements CurrentUserTodos & Noteable {
): AwardEmojiConnection
"""
Children (sub-epics) of the epic
Children (sub-epics) of the epic.
"""
children(
"""
......@@ -8545,17 +8545,17 @@ type Epic implements CurrentUserTodos & Noteable {
): EpicConnection
"""
Timestamp of when the epic was closed
Timestamp of when the epic was closed.
"""
closedAt: Time
"""
Indicates if the epic is confidential
Indicates if the epic is confidential.
"""
confidential: Boolean
"""
Timestamp of when the epic was created
Timestamp of when the epic was created.
"""
createdAt: Time
......@@ -8590,17 +8590,17 @@ type Epic implements CurrentUserTodos & Noteable {
): TodoConnection!
"""
Number of open and closed descendant epics and issues
Number of open and closed descendant epics and issues.
"""
descendantCounts: EpicDescendantCount
"""
Total weight of open and closed issues in the epic and its descendants
Total weight of open and closed issues in the epic and its descendants.
"""
descendantWeightSum: EpicDescendantWeights
"""
Description of the epic
Description of the epic.
"""
description: String
......@@ -8630,67 +8630,67 @@ type Epic implements CurrentUserTodos & Noteable {
): DiscussionConnection!
"""
Number of downvotes the epic has received
Number of downvotes the epic has received.
"""
downvotes: Int!
"""
Due date of the epic
Due date of the epic.
"""
dueDate: Time
"""
Fixed due date of the epic
Fixed due date of the epic.
"""
dueDateFixed: Time
"""
Inherited due date of the epic from milestones
Inherited due date of the epic from milestones.
"""
dueDateFromMilestones: Time
"""
Indicates if the due date has been manually set
Indicates if the due date has been manually set.
"""
dueDateIsFixed: Boolean
"""
Group to which the epic belongs
Group to which the epic belongs.
"""
group: Group!
"""
Indicates if the epic has children
Indicates if the epic has children.
"""
hasChildren: Boolean!
"""
Indicates if the epic has direct issues
Indicates if the epic has direct issues.
"""
hasIssues: Boolean!
"""
Indicates if the epic has a parent epic
Indicates if the epic has a parent epic.
"""
hasParent: Boolean!
"""
Current health status of the epic
Current health status of the epic.
"""
healthStatus: EpicHealthStatus
"""
ID of the epic
ID of the epic.
"""
id: ID!
"""
Internal ID of the epic
Internal ID of the epic.
"""
iid: ID!
"""
A list of issues associated with the epic
A list of issues associated with the epic.
"""
issues(
"""
......@@ -8715,7 +8715,7 @@ type Epic implements CurrentUserTodos & Noteable {
): EpicIssueConnection
"""
Labels assigned to the epic
Labels assigned to the epic.
"""
labels(
"""
......@@ -8765,12 +8765,12 @@ type Epic implements CurrentUserTodos & Noteable {
): NoteConnection!
"""
Parent epic of the epic
Parent epic of the epic.
"""
parent: Epic
"""
List of participants for the epic
List of participants for the epic.
"""
participants(
"""
......@@ -8795,77 +8795,77 @@ type Epic implements CurrentUserTodos & Noteable {
): UserConnection
"""
Internal reference of the epic. Returned in shortened format by default
Internal reference of the epic. Returned in shortened format by default.
"""
reference(
"""
Indicates if the reference should be returned in full
Indicates if the reference should be returned in full.
"""
full: Boolean = false
): String!
"""
URI path of the epic-issue relationship
URI path of the epic-issue relationship.
"""
relationPath: String
"""
The relative position of the epic in the epic tree
The relative position of the epic in the epic tree.
"""
relativePosition: Int
"""
Start date of the epic
Start date of the epic.
"""
startDate: Time
"""
Fixed start date of the epic
Fixed start date of the epic.
"""
startDateFixed: Time
"""
Inherited start date of the epic from milestones
Inherited start date of the epic from milestones.
"""
startDateFromMilestones: Time
"""
Indicates if the start date has been manually set
Indicates if the start date has been manually set.
"""
startDateIsFixed: Boolean
"""
State of the epic
State of the epic.
"""
state: EpicState!
"""
Indicates the currently logged in user is subscribed to the epic
Indicates the currently logged in user is subscribed to the epic.
"""
subscribed: Boolean!
"""
Title of the epic
Title of the epic.
"""
title: String
"""
Timestamp of when the epic was updated
Timestamp of when the epic was updated.
"""
updatedAt: Time
"""
Number of upvotes the epic has received
Number of upvotes the epic has received.
"""
upvotes: Int!
"""
Number of user discussions in the epic
Number of user discussions in the epic.
"""
userDiscussionsCount: Int!
"""
Number of user notes of the epic
Number of user notes of the epic.
"""
userNotesCount: Int!
......@@ -8875,12 +8875,12 @@ type Epic implements CurrentUserTodos & Noteable {
userPermissions: EpicPermissions!
"""
Web path of the epic
Web path of the epic.
"""
webPath: String!
"""
Web URL of the epic
Web URL of the epic.
"""
webUrl: String!
}
......
doc/api/graphql/reference/gitlab_schema.json
View file @ 2a077531
......@@ -4097,7 +4097,7 @@
"fields": [
{
"name": "author",
"description": "Author of the epic",
"description": "Author of the epic.",
"args": [
],
......@@ -4115,7 +4115,7 @@
},
{
"name": "awardEmoji",
"description": "A list of award emojis associated with the epic",
"description": "A list of award emojis associated with the epic.",
"args": [
{
"name": "after",
......@@ -4168,7 +4168,7 @@
},
{
"name": "children",
"description": "Children (sub-epics) of the epic",
"description": "Children (sub-epics) of the epic.",
"args": [
{
"name": "startDate",
......@@ -4377,7 +4377,7 @@
},
{
"name": "closedAt",
"description": "Timestamp of when the epic was closed",
"description": "Timestamp of when the epic was closed.",
"args": [
],
......@@ -4391,7 +4391,7 @@
},
{
"name": "confidential",
"description": "Indicates if the epic is confidential",
"description": "Indicates if the epic is confidential.",
"args": [
],
......@@ -4405,7 +4405,7 @@
},
{
"name": "createdAt",
"description": "Timestamp of when the epic was created",
"description": "Timestamp of when the epic was created.",
"args": [
],
......@@ -4486,7 +4486,7 @@
},
{
"name": "descendantCounts",
"description": "Number of open and closed descendant epics and issues",
"description": "Number of open and closed descendant epics and issues.",
"args": [
],
......@@ -4500,7 +4500,7 @@
},
{
"name": "descendantWeightSum",
"description": "Total weight of open and closed issues in the epic and its descendants",
"description": "Total weight of open and closed issues in the epic and its descendants.",
"args": [
],
......@@ -4514,7 +4514,7 @@
},
{
"name": "description",
"description": "Description of the epic",
"description": "Description of the epic.",
"args": [
],
......@@ -4585,7 +4585,7 @@
},
{
"name": "downvotes",
"description": "Number of downvotes the epic has received",
"description": "Number of downvotes the epic has received.",
"args": [
],
......@@ -4603,7 +4603,7 @@
},
{
"name": "dueDate",
"description": "Due date of the epic",
"description": "Due date of the epic.",
"args": [
],
......@@ -4617,7 +4617,7 @@
},
{
"name": "dueDateFixed",
"description": "Fixed due date of the epic",
"description": "Fixed due date of the epic.",
"args": [
],
......@@ -4631,7 +4631,7 @@
},
{
"name": "dueDateFromMilestones",
"description": "Inherited due date of the epic from milestones",
"description": "Inherited due date of the epic from milestones.",
"args": [
],
......@@ -4645,7 +4645,7 @@
},
{
"name": "dueDateIsFixed",
"description": "Indicates if the due date has been manually set",
"description": "Indicates if the due date has been manually set.",
"args": [
],
......@@ -4659,7 +4659,7 @@
},
{
"name": "group",
"description": "Group to which the epic belongs",
"description": "Group to which the epic belongs.",
"args": [
],
......@@ -4677,7 +4677,7 @@
},
{
"name": "hasChildren",
"description": "Indicates if the epic has children",
"description": "Indicates if the epic has children.",
"args": [
],
......@@ -4695,7 +4695,7 @@
},
{
"name": "hasIssues",
"description": "Indicates if the epic has direct issues",
"description": "Indicates if the epic has direct issues.",
"args": [
],
......@@ -4713,7 +4713,7 @@
},
{
"name": "hasParent",
"description": "Indicates if the epic has a parent epic",
"description": "Indicates if the epic has a parent epic.",
"args": [
],
......@@ -4731,7 +4731,7 @@
},
{
"name": "healthStatus",
"description": "Current health status of the epic",
"description": "Current health status of the epic.",
"args": [
],
......@@ -4745,7 +4745,7 @@
},
{
"name": "id",
"description": "ID of the epic",
"description": "ID of the epic.",
"args": [
],
......@@ -4763,7 +4763,7 @@
},
{
"name": "iid",
"description": "Internal ID of the epic",
"description": "Internal ID of the epic.",
"args": [
],
......@@ -4781,7 +4781,7 @@
},
{
"name": "issues",
"description": "A list of issues associated with the epic",
"description": "A list of issues associated with the epic.",
"args": [
{
"name": "after",
......@@ -4834,7 +4834,7 @@
},
{
"name": "labels",
"description": "Labels assigned to the epic",
"description": "Labels assigned to the epic.",
"args": [
{
"name": "after",
......@@ -4944,7 +4944,7 @@
},
{
"name": "parent",
"description": "Parent epic of the epic",
"description": "Parent epic of the epic.",
"args": [
],
......@@ -4958,7 +4958,7 @@
},
{
"name": "participants",
"description": "List of participants for the epic",
"description": "List of participants for the epic.",
"args": [
{
"name": "after",
......@@ -5011,11 +5011,11 @@
},
{
"name": "reference",
"description": "Internal reference of the epic. Returned in shortened format by default",
"description": "Internal reference of the epic. Returned in shortened format by default.",
"args": [
{
"name": "full",
"description": "Indicates if the reference should be returned in full",
"description": "Indicates if the reference should be returned in full.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -5038,7 +5038,7 @@
},
{
"name": "relationPath",
"description": "URI path of the epic-issue relationship",
"description": "URI path of the epic-issue relationship.",
"args": [
],
......@@ -5052,7 +5052,7 @@
},
{
"name": "relativePosition",
"description": "The relative position of the epic in the epic tree",
"description": "The relative position of the epic in the epic tree.",
"args": [
],
......@@ -5066,7 +5066,7 @@
},
{
"name": "startDate",
"description": "Start date of the epic",
"description": "Start date of the epic.",
"args": [
],
......@@ -5080,7 +5080,7 @@
},
{
"name": "startDateFixed",
"description": "Fixed start date of the epic",
"description": "Fixed start date of the epic.",
"args": [
],
......@@ -5094,7 +5094,7 @@
},
{
"name": "startDateFromMilestones",
"description": "Inherited start date of the epic from milestones",
"description": "Inherited start date of the epic from milestones.",
"args": [
],
......@@ -5108,7 +5108,7 @@
},
{
"name": "startDateIsFixed",
"description": "Indicates if the start date has been manually set",
"description": "Indicates if the start date has been manually set.",
"args": [
],
......@@ -5122,7 +5122,7 @@
},
{
"name": "state",
"description": "State of the epic",
"description": "State of the epic.",
"args": [
],
......@@ -5140,7 +5140,7 @@
},
{
"name": "subscribed",
"description": "Indicates the currently logged in user is subscribed to the epic",
"description": "Indicates the currently logged in user is subscribed to the epic.",
"args": [
],
......@@ -5158,7 +5158,7 @@
},
{
"name": "title",
"description": "Title of the epic",
"description": "Title of the epic.",
"args": [
],
......@@ -5172,7 +5172,7 @@
},
{
"name": "updatedAt",
"description": "Timestamp of when the epic was updated",
"description": "Timestamp of when the epic was updated.",
"args": [
],
......@@ -5186,7 +5186,7 @@
},
{
"name": "upvotes",
"description": "Number of upvotes the epic has received",
"description": "Number of upvotes the epic has received.",
"args": [
],
......@@ -5204,7 +5204,7 @@
},
{
"name": "userDiscussionsCount",
"description": "Number of user discussions in the epic",
"description": "Number of user discussions in the epic.",
"args": [
],
......@@ -5222,7 +5222,7 @@
},
{
"name": "userNotesCount",
"description": "Number of user notes of the epic",
"description": "Number of user notes of the epic.",
"args": [
],
......@@ -5272,7 +5272,7 @@
},
{
"name": "webPath",
"description": "Web path of the epic",
"description": "Web path of the epic.",
"args": [
],
......@@ -5290,7 +5290,7 @@
},
{
"name": "webUrl",
"description": "Web URL of the epic",
"description": "Web URL of the epic.",
"args": [
],
......@@ -23328,7 +23328,7 @@
"fields": [
{
"name": "author",
"description": "Author of the epic",
"description": "Author of the epic.",
"args": [
],
......@@ -23346,7 +23346,7 @@
},
{
"name": "awardEmoji",
"description": "A list of award emojis associated with the epic",
"description": "A list of award emojis associated with the epic.",
"args": [
{
"name": "after",
......@@ -23399,7 +23399,7 @@
},
{
"name": "children",
"description": "Children (sub-epics) of the epic",
"description": "Children (sub-epics) of the epic.",
"args": [
{
"name": "startDate",
......@@ -23608,7 +23608,7 @@
},
{
"name": "closedAt",
"description": "Timestamp of when the epic was closed",
"description": "Timestamp of when the epic was closed.",
"args": [
],
......@@ -23622,7 +23622,7 @@
},
{
"name": "confidential",
"description": "Indicates if the epic is confidential",
"description": "Indicates if the epic is confidential.",
"args": [
],
......@@ -23636,7 +23636,7 @@
},
{
"name": "createdAt",
"description": "Timestamp of when the epic was created",
"description": "Timestamp of when the epic was created.",
"args": [
],
......@@ -23717,7 +23717,7 @@
},
{
"name": "descendantCounts",
"description": "Number of open and closed descendant epics and issues",
"description": "Number of open and closed descendant epics and issues.",
"args": [
],
......@@ -23731,7 +23731,7 @@
},
{
"name": "descendantWeightSum",
"description": "Total weight of open and closed issues in the epic and its descendants",
"description": "Total weight of open and closed issues in the epic and its descendants.",
"args": [
],
......@@ -23745,7 +23745,7 @@
},
{
"name": "description",
"description": "Description of the epic",
"description": "Description of the epic.",
"args": [
],
......@@ -23816,7 +23816,7 @@
},
{
"name": "downvotes",
"description": "Number of downvotes the epic has received",
"description": "Number of downvotes the epic has received.",
"args": [
],
......@@ -23834,7 +23834,7 @@
},
{
"name": "dueDate",
"description": "Due date of the epic",
"description": "Due date of the epic.",
"args": [
],
......@@ -23848,7 +23848,7 @@
},
{
"name": "dueDateFixed",
"description": "Fixed due date of the epic",
"description": "Fixed due date of the epic.",
"args": [
],
......@@ -23862,7 +23862,7 @@
},
{
"name": "dueDateFromMilestones",
"description": "Inherited due date of the epic from milestones",
"description": "Inherited due date of the epic from milestones.",
"args": [
],
......@@ -23876,7 +23876,7 @@
},
{
"name": "dueDateIsFixed",
"description": "Indicates if the due date has been manually set",
"description": "Indicates if the due date has been manually set.",
"args": [
],
......@@ -23890,7 +23890,7 @@
},
{
"name": "group",
"description": "Group to which the epic belongs",
"description": "Group to which the epic belongs.",
"args": [
],
......@@ -23908,7 +23908,7 @@
},
{
"name": "hasChildren",
"description": "Indicates if the epic has children",
"description": "Indicates if the epic has children.",
"args": [
],
......@@ -23926,7 +23926,7 @@
},
{
"name": "hasIssues",
"description": "Indicates if the epic has direct issues",
"description": "Indicates if the epic has direct issues.",
"args": [
],
......@@ -23944,7 +23944,7 @@
},
{
"name": "hasParent",
"description": "Indicates if the epic has a parent epic",
"description": "Indicates if the epic has a parent epic.",
"args": [
],
......@@ -23962,7 +23962,7 @@
},
{
"name": "healthStatus",
"description": "Current health status of the epic",
"description": "Current health status of the epic.",
"args": [
],
......@@ -23976,7 +23976,7 @@
},
{
"name": "id",
"description": "ID of the epic",
"description": "ID of the epic.",
"args": [
],
......@@ -23994,7 +23994,7 @@
},
{
"name": "iid",
"description": "Internal ID of the epic",
"description": "Internal ID of the epic.",
"args": [
],
......@@ -24012,7 +24012,7 @@
},
{
"name": "issues",
"description": "A list of issues associated with the epic",
"description": "A list of issues associated with the epic.",
"args": [
{
"name": "after",
......@@ -24065,7 +24065,7 @@
},
{
"name": "labels",
"description": "Labels assigned to the epic",
"description": "Labels assigned to the epic.",
"args": [
{
"name": "after",
......@@ -24175,7 +24175,7 @@
},
{
"name": "parent",
"description": "Parent epic of the epic",
"description": "Parent epic of the epic.",
"args": [
],
......@@ -24189,7 +24189,7 @@
},
{
"name": "participants",
"description": "List of participants for the epic",
"description": "List of participants for the epic.",
"args": [
{
"name": "after",
......@@ -24242,11 +24242,11 @@
},
{
"name": "reference",
"description": "Internal reference of the epic. Returned in shortened format by default",
"description": "Internal reference of the epic. Returned in shortened format by default.",
"args": [
{
"name": "full",
"description": "Indicates if the reference should be returned in full",
"description": "Indicates if the reference should be returned in full.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
......@@ -24269,7 +24269,7 @@
},
{
"name": "relationPath",
"description": "URI path of the epic-issue relationship",
"description": "URI path of the epic-issue relationship.",
"args": [
],
......@@ -24283,7 +24283,7 @@
},
{
"name": "relativePosition",
"description": "The relative position of the epic in the epic tree",
"description": "The relative position of the epic in the epic tree.",
"args": [
],
......@@ -24297,7 +24297,7 @@
},
{
"name": "startDate",
"description": "Start date of the epic",
"description": "Start date of the epic.",
"args": [
],
......@@ -24311,7 +24311,7 @@
},
{
"name": "startDateFixed",
"description": "Fixed start date of the epic",
"description": "Fixed start date of the epic.",
"args": [
],
......@@ -24325,7 +24325,7 @@
},
{
"name": "startDateFromMilestones",
"description": "Inherited start date of the epic from milestones",
"description": "Inherited start date of the epic from milestones.",
"args": [
],
......@@ -24339,7 +24339,7 @@
},
{
"name": "startDateIsFixed",
"description": "Indicates if the start date has been manually set",
"description": "Indicates if the start date has been manually set.",
"args": [
],
......@@ -24353,7 +24353,7 @@
},
{
"name": "state",
"description": "State of the epic",
"description": "State of the epic.",
"args": [
],
......@@ -24371,7 +24371,7 @@
},
{
"name": "subscribed",
"description": "Indicates the currently logged in user is subscribed to the epic",
"description": "Indicates the currently logged in user is subscribed to the epic.",
"args": [
],
......@@ -24389,7 +24389,7 @@
},
{
"name": "title",
"description": "Title of the epic",
"description": "Title of the epic.",
"args": [
],
......@@ -24403,7 +24403,7 @@
},
{
"name": "updatedAt",
"description": "Timestamp of when the epic was updated",
"description": "Timestamp of when the epic was updated.",
"args": [
],
......@@ -24417,7 +24417,7 @@
},
{
"name": "upvotes",
"description": "Number of upvotes the epic has received",
"description": "Number of upvotes the epic has received.",
"args": [
],
......@@ -24435,7 +24435,7 @@
},
{
"name": "userDiscussionsCount",
"description": "Number of user discussions in the epic",
"description": "Number of user discussions in the epic.",
"args": [
],
......@@ -24453,7 +24453,7 @@
},
{
"name": "userNotesCount",
"description": "Number of user notes of the epic",
"description": "Number of user notes of the epic.",
"args": [
],
......@@ -24489,7 +24489,7 @@
},
{
"name": "webPath",
"description": "Web path of the epic",
"description": "Web path of the epic.",
"args": [
],
......@@ -24507,7 +24507,7 @@
},
{
"name": "webUrl",
"description": "Web URL of the epic",
"description": "Web URL of the epic.",
"args": [
],
doc/api/graphql/reference/index.md
View file @ 2a077531
......@@ -262,52 +262,52 @@ Represents an epic on an issue board.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `author` | User! | Author of the epic |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic |
| `children` | EpicConnection | Children (sub-epics) of the 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 |
| `author` | User! | Author of the epic. |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. |
| `children` | EpicConnection | Children (sub-epics) of the 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. |
| `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 |
| `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. |
| `discussions` | DiscussionConnection! | All discussions on this noteable |
| `downvotes` | Int! | Number of downvotes the epic has received |
| `dueDate` | Time | Due date of the epic |
| `dueDateFixed` | Time | Fixed due date of the epic |
| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones |
| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set |
| `group` | Group! | Group to which the epic belongs |
| `hasChildren` | Boolean! | Indicates if the epic has children |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues |
| `hasParent` | Boolean! | Indicates if the epic has a parent epic |
| `healthStatus` | EpicHealthStatus | Current health status of the epic |
| `id` | ID! | ID of the epic |
| `iid` | ID! | Internal ID of the epic |
| `issues` | EpicIssueConnection | A list of issues associated with the epic |
| `labels` | LabelConnection | Labels assigned to the epic |
| `downvotes` | Int! | Number of downvotes the epic has received. |
| `dueDate` | Time | Due date of the epic. |
| `dueDateFixed` | Time | Fixed due date of the epic. |
| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones. |
| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set. |
| `group` | Group! | Group to which the epic belongs. |
| `hasChildren` | Boolean! | Indicates if the epic has children. |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues. |
| `hasParent` | Boolean! | Indicates if the epic has a parent epic. |
| `healthStatus` | EpicHealthStatus | Current health status of the epic. |
| `id` | ID! | ID of the epic. |
| `iid` | ID! | Internal ID of the epic. |
| `issues` | EpicIssueConnection | A list of issues associated with the epic. |
| `labels` | LabelConnection | Labels assigned to the epic. |
| `notes` | NoteConnection! | All notes on this noteable |
| `parent` | Epic | Parent epic of the epic |
| `participants` | UserConnection | List of participants for the epic |
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relationship |
| `relativePosition` | Int | The relative position of the epic in the epic tree |
| `startDate` | Time | Start date of the epic |
| `startDateFixed` | Time | Fixed start date of the epic |
| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones |
| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set |
| `state` | EpicState! | State of the epic |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic |
| `title` | String | Title of the epic |
| `updatedAt` | Time | Timestamp of when the epic was updated |
| `upvotes` | Int! | Number of upvotes the epic has received |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic |
| `userNotesCount` | Int! | Number of user notes of the epic |
| `parent` | Epic | Parent epic of the epic. |
| `participants` | UserConnection | List of participants for the epic. |
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default. |
| `relationPath` | String | URI path of the epic-issue relationship. |
| `relativePosition` | Int | The relative position of the epic in the epic tree. |
| `startDate` | Time | Start date of the epic. |
| `startDateFixed` | Time | Fixed start date of the epic. |
| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones. |
| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set. |
| `state` | EpicState! | State of the epic. |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic. |
| `title` | String | Title of the epic. |
| `updatedAt` | Time | Timestamp of when the epic was updated. |
| `upvotes` | Int! | Number of upvotes the epic has received. |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic. |
| `userNotesCount` | Int! | Number of user notes of the epic. |
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
| `userPreferences` | BoardEpicUserPreferences | User preferences for the epic on the issue board |
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |
| `webPath` | String! | Web path of the epic. |
| `webUrl` | String! | Web URL of the epic. |
### BoardEpicUserPreferences
......@@ -1384,51 +1384,51 @@ Represents an epic.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `author` | User! | Author of the epic |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic |
| `children` | EpicConnection | Children (sub-epics) of the 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 |
| `author` | User! | Author of the epic. |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. |
| `children` | EpicConnection | Children (sub-epics) of the 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. |
| `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 |
| `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. |
| `discussions` | DiscussionConnection! | All discussions on this noteable |
| `downvotes` | Int! | Number of downvotes the epic has received |
| `dueDate` | Time | Due date of the epic |
| `dueDateFixed` | Time | Fixed due date of the epic |
| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones |
| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set |
| `group` | Group! | Group to which the epic belongs |
| `hasChildren` | Boolean! | Indicates if the epic has children |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues |
| `hasParent` | Boolean! | Indicates if the epic has a parent epic |
| `healthStatus` | EpicHealthStatus | Current health status of the epic |
| `id` | ID! | ID of the epic |
| `iid` | ID! | Internal ID of the epic |
| `issues` | EpicIssueConnection | A list of issues associated with the epic |
| `labels` | LabelConnection | Labels assigned to the epic |
| `downvotes` | Int! | Number of downvotes the epic has received. |
| `dueDate` | Time | Due date of the epic. |
| `dueDateFixed` | Time | Fixed due date of the epic. |
| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones. |
| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set. |
| `group` | Group! | Group to which the epic belongs. |
| `hasChildren` | Boolean! | Indicates if the epic has children. |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues. |
| `hasParent` | Boolean! | Indicates if the epic has a parent epic. |
| `healthStatus` | EpicHealthStatus | Current health status of the epic. |
| `id` | ID! | ID of the epic. |
| `iid` | ID! | Internal ID of the epic. |
| `issues` | EpicIssueConnection | A list of issues associated with the epic. |
| `labels` | LabelConnection | Labels assigned to the epic. |
| `notes` | NoteConnection! | All notes on this noteable |
| `parent` | Epic | Parent epic of the epic |
| `participants` | UserConnection | List of participants for the epic |
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relationship |
| `relativePosition` | Int | The relative position of the epic in the epic tree |
| `startDate` | Time | Start date of the epic |
| `startDateFixed` | Time | Fixed start date of the epic |
| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones |
| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set |
| `state` | EpicState! | State of the epic |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic |
| `title` | String | Title of the epic |
| `updatedAt` | Time | Timestamp of when the epic was updated |
| `upvotes` | Int! | Number of upvotes the epic has received |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic |
| `userNotesCount` | Int! | Number of user notes of the epic |
| `parent` | Epic | Parent epic of the epic. |
| `participants` | UserConnection | List of participants for the epic. |
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default. |
| `relationPath` | String | URI path of the epic-issue relationship. |
| `relativePosition` | Int | The relative position of the epic in the epic tree. |
| `startDate` | Time | Start date of the epic. |
| `startDateFixed` | Time | Fixed start date of the epic. |
| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones. |
| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set. |
| `state` | EpicState! | State of the epic. |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic. |
| `title` | String | Title of the epic. |
| `updatedAt` | Time | Timestamp of when the epic was updated. |
| `upvotes` | Int! | Number of upvotes the epic has received. |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic. |
| `userNotesCount` | Int! | Number of user notes of the epic. |
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |
| `webPath` | String! | Web path of the epic. |
| `webUrl` | String! | Web URL of the epic. |
### EpicAddIssuePayload
......
ee/app/graphql/types/epic_type.rb
View file @ 2a077531
......@@ -17,134 +17,134 @@ module Types
implements(Types::CurrentUserTodos)
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the epic'
description: 'ID of the epic.'
field :iid, GraphQL::ID_TYPE, null: false,
description: 'Internal ID of the epic'
description: 'Internal ID of the epic.'
field :title, GraphQL::STRING_TYPE, null: true,
description: 'Title of the epic'
description: 'Title of the epic.'
field :description, GraphQL::STRING_TYPE, null: true,
description: 'Description of the epic'
description: 'Description of the epic.'
field :state, EpicStateEnum, null: false,
description: 'State of the epic'
description: 'State of the epic.'
field :confidential, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the epic is confidential'
description: 'Indicates if the epic is confidential.'
field :group, GroupType, null: false,
description: 'Group to which the epic belongs'
description: 'Group to which the epic belongs.'
field :parent, EpicType, null: true,
description: 'Parent epic of the epic'
description: 'Parent epic of the epic.'
field :author, Types::UserType, null: false,
description: 'Author of the epic'
description: 'Author of the epic.'
field :start_date, Types::TimeType, null: true,
description: 'Start date of the epic'
description: 'Start date of the epic.'
field :start_date_is_fixed, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the start date has been manually set',
description: 'Indicates if the start date has been manually set.',
method: :start_date_is_fixed?, authorize: :admin_epic
field :start_date_fixed, Types::TimeType, null: true,
description: 'Fixed start date of the epic',
description: 'Fixed start date of the epic.',
authorize: :admin_epic
field :start_date_from_milestones, Types::TimeType, null: true,
description: 'Inherited start date of the epic from milestones',
description: 'Inherited start date of the epic from milestones.',
authorize: :admin_epic
field :due_date, Types::TimeType, null: true,
description: 'Due date of the epic'
description: 'Due date of the epic.'
field :due_date_is_fixed, GraphQL::BOOLEAN_TYPE, null: true,
description: 'Indicates if the due date has been manually set',
description: 'Indicates if the due date has been manually set.',
method: :due_date_is_fixed?, authorize: :admin_epic
field :due_date_fixed, Types::TimeType, null: true,
description: 'Fixed due date of the epic',
description: 'Fixed due date of the epic.',
authorize: :admin_epic
field :due_date_from_milestones, Types::TimeType, null: true,
description: 'Inherited due date of the epic from milestones',
description: 'Inherited due date of the epic from milestones.',
authorize: :admin_epic
field :upvotes, GraphQL::INT_TYPE, null: false,
description: 'Number of upvotes the epic has received'
description: 'Number of upvotes the epic has received.'
field :downvotes, GraphQL::INT_TYPE, null: false,
description: 'Number of downvotes the epic has received'
description: 'Number of downvotes the epic has received.'
field :user_notes_count, GraphQL::INT_TYPE, null: false,
description: 'Number of user notes of the epic',
description: 'Number of user notes of the epic.',
resolver: Resolvers::UserNotesCountResolver
field :user_discussions_count, GraphQL::INT_TYPE, null: false,
description: 'Number of user discussions in the epic',
description: 'Number of user discussions in the epic.',
resolver: Resolvers::UserDiscussionsCountResolver
field :closed_at, Types::TimeType, null: true,
description: 'Timestamp of when the epic was closed'
description: 'Timestamp of when the epic was closed.'
field :created_at, Types::TimeType, null: true,
description: 'Timestamp of when the epic was created'
description: 'Timestamp of when the epic was created.'
field :updated_at, Types::TimeType, null: true,
description: 'Timestamp of when the epic was updated'
description: 'Timestamp of when the epic was updated.'
field :children, ::Types::EpicType.connection_type, null: true,
description: 'Children (sub-epics) of the epic',
description: 'Children (sub-epics) of the epic.',
max_page_size: 2000,
resolver: ::Resolvers::EpicsResolver
field :labels, Types::LabelType.connection_type, null: true,
description: 'Labels assigned to the epic'
description: 'Labels assigned to the epic.'
field :has_children, GraphQL::BOOLEAN_TYPE, null: false,
description: 'Indicates if the epic has children'
description: 'Indicates if the epic has children.'
field :has_issues, GraphQL::BOOLEAN_TYPE, null: false,
description: 'Indicates if the epic has direct issues'
description: 'Indicates if the epic has direct issues.'
field :has_parent, GraphQL::BOOLEAN_TYPE, null: false,
method: :has_parent?,
description: 'Indicates if the epic has a parent epic'
description: 'Indicates if the epic has a parent epic.'
field :web_path, GraphQL::STRING_TYPE, null: false,
description: 'Web path of the epic',
description: 'Web path of the epic.',
method: :group_epic_path
field :web_url, GraphQL::STRING_TYPE, null: false,
description: 'Web URL of the epic',
description: 'Web URL of the epic.',
method: :group_epic_url
field :relative_position, GraphQL::INT_TYPE, null: true,
description: 'The relative position of the epic in the epic tree'
description: 'The relative position of the epic in the epic tree.'
field :relation_path, GraphQL::STRING_TYPE, null: true,
description: 'URI path of the epic-issue relationship',
description: 'URI path of the epic-issue relationship.',
method: :group_epic_link_path
field :reference, GraphQL::STRING_TYPE, null: false,
description: 'Internal reference of the epic. Returned in shortened format by default',
description: 'Internal reference of the epic. Returned in shortened format by default.',
method: :epic_reference do
argument :full, GraphQL::BOOLEAN_TYPE, required: false, default_value: false,
description: 'Indicates if the reference should be returned in full'
description: 'Indicates if the reference should be returned in full.'
end
field :participants, Types::UserType.connection_type, null: true,
description: 'List of participants for the epic',
description: 'List of participants for the epic.',
complexity: 5
field :subscribed, GraphQL::BOOLEAN_TYPE,
method: :subscribed?,
null: false,
complexity: 5,
description: 'Indicates the currently logged in user is subscribed to the epic'
description: 'Indicates the currently logged in user is subscribed to the epic.'
field :issues,
Types::EpicIssueType.connection_type,
null: true,
complexity: 5,
description: 'A list of issues associated with the epic',
description: 'A list of issues associated with the epic.',
max_page_size: 2000,
resolver: Resolvers::EpicIssuesResolver
field :descendant_counts, Types::EpicDescendantCountType, null: true,
description: 'Number of open and closed descendant epics and issues'
description: 'Number of open and closed descendant epics and issues.'
field :descendant_weight_sum, Types::EpicDescendantWeightSumType, null: true,
description: "Total weight of open and closed issues in the epic and its descendants"
description: 'Total weight of open and closed issues in the epic and its descendants.'
field :health_status, Types::EpicHealthStatusType, null: true, complexity: 10,
description: 'Current health status of the epic'
description: 'Current health status of the epic.'
field :award_emoji,
Types::AwardEmojis::AwardEmojiType.connection_type,
null: true,
description: 'A list of award emojis associated with the epic'
description: 'A list of award emojis associated with the epic.'
def has_children?
Gitlab::Graphql::Aggregations::Epics::LazyEpicAggregate.new(context, object.id, COUNT) do |node, _aggregate_object|
......
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