Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
e45bf70d
Commit
e45bf70d
authored
Feb 07, 2020
by
Eugenia Grieff
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Backfill GraphQL descriptions
- Add missing description to Epic type - Regenerate schema and documentation
parent
be711a8d
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
48 additions
and
15 deletions
+48
-15
doc/api/graphql/reference/gitlab_schema.graphql
doc/api/graphql/reference/gitlab_schema.graphql
+22
-1
doc/api/graphql/reference/gitlab_schema.json
doc/api/graphql/reference/gitlab_schema.json
+5
-5
doc/api/graphql/reference/index.md
doc/api/graphql/reference/index.md
+4
-4
ee/app/graphql/types/epic_type.rb
ee/app/graphql/types/epic_type.rb
+17
-5
No files found.
doc/api/graphql/reference/gitlab_schema.graphql
View file @
e45bf70d
...
@@ -1986,7 +1986,20 @@ type Epic implements Noteable {
...
@@ -1986,7 +1986,20 @@ type Epic implements Noteable {
"""
"""
last
:
Int
last
:
Int
):
UserConnection
):
UserConnection
reference
(
full
:
Boolean
=
false
):
String
!
"""
Internal
reference
of
the
epic
.
Returned
in
shortened
format
by
default
"""
reference
(
"""
Indicates
if
the
reference
should
be
returned
in
full
"""
full
:
Boolean
=
false
):
String
!
"""
URI
path
of
the
epic
-
issue
relationship
"""
relationPath
:
String
relationPath
:
String
"""
"""
...
@@ -2043,7 +2056,15 @@ type Epic implements Noteable {
...
@@ -2043,7 +2056,15 @@ type Epic implements Noteable {
Permissions
for
the
current
user
on
the
resource
Permissions
for
the
current
user
on
the
resource
"""
"""
userPermissions
:
EpicPermissions
!
userPermissions
:
EpicPermissions
!
"""
Web
path
of
the
epic
"""
webPath
:
String
!
webPath
:
String
!
"""
Web
URL
of
the
epic
"""
webUrl
:
String
!
webUrl
:
String
!
}
}
...
...
doc/api/graphql/reference/gitlab_schema.json
View file @
e45bf70d
...
@@ -5013,11 +5013,11 @@
...
@@ -5013,11 +5013,11 @@
},
},
{
{
"name"
:
"reference"
,
"name"
:
"reference"
,
"description"
:
null
,
"description"
:
"Internal reference of the epic. Returned in shortened format by default"
,
"args"
:
[
"args"
:
[
{
{
"name"
:
"full"
,
"name"
:
"full"
,
"description"
:
null
,
"description"
:
"Indicates if the reference should be returned in full"
,
"type"
:
{
"type"
:
{
"kind"
:
"SCALAR"
,
"kind"
:
"SCALAR"
,
"name"
:
"Boolean"
,
"name"
:
"Boolean"
,
...
@@ -5040,7 +5040,7 @@
...
@@ -5040,7 +5040,7 @@
},
},
{
{
"name"
:
"relationPath"
,
"name"
:
"relationPath"
,
"description"
:
null
,
"description"
:
"URI path of the epic-issue relationship"
,
"args"
:
[
"args"
:
[
],
],
...
@@ -5224,7 +5224,7 @@
...
@@ -5224,7 +5224,7 @@
},
},
{
{
"name"
:
"webPath"
,
"name"
:
"webPath"
,
"description"
:
null
,
"description"
:
"Web path of the epic"
,
"args"
:
[
"args"
:
[
],
],
...
@@ -5242,7 +5242,7 @@
...
@@ -5242,7 +5242,7 @@
},
},
{
{
"name"
:
"webUrl"
,
"name"
:
"webUrl"
,
"description"
:
null
,
"description"
:
"Web URL of the epic"
,
"args"
:
[
"args"
:
[
],
],
...
...
doc/api/graphql/reference/index.md
View file @
e45bf70d
...
@@ -295,8 +295,8 @@ Represents an epic.
...
@@ -295,8 +295,8 @@ Represents an epic.
|
`id`
| ID! | ID of the epic |
|
`id`
| ID! | ID of the epic |
|
`iid`
| ID! | Internal ID of the epic |
|
`iid`
| ID! | Internal ID of the epic |
|
`parent`
| Epic | Parent epic of the epic |
|
`parent`
| Epic | Parent epic of the epic |
|
`reference`
| String! | |
|
`reference`
| String! |
Internal reference of the epic. Returned in shortened format by default
|
|
`relationPath`
| String | |
|
`relationPath`
| String |
URI path of the epic-issue relationship
|
|
`relativePosition`
| Int | The relative position of the epic in the epic tree |
|
`relativePosition`
| Int | The relative position of the epic in the epic tree |
|
`startDate`
| Time | Start date of the epic |
|
`startDate`
| Time | Start date of the epic |
|
`startDateFixed`
| Time | Fixed start date of the epic |
|
`startDateFixed`
| Time | Fixed start date of the epic |
...
@@ -308,8 +308,8 @@ Represents an epic.
...
@@ -308,8 +308,8 @@ Represents an epic.
|
`updatedAt`
| Time | Timestamp of the epic's last activity |
|
`updatedAt`
| Time | Timestamp of the epic's last activity |
|
`upvotes`
| Int! | Number of upvotes the epic has received |
|
`upvotes`
| Int! | Number of upvotes the epic has received |
|
`userPermissions`
| EpicPermissions! | Permissions for the current user on the resource |
|
`userPermissions`
| EpicPermissions! | Permissions for the current user on the resource |
|
`webPath`
| String! | |
|
`webPath`
| String! |
Web path of the epic
|
|
`webUrl`
| String! | |
|
`webUrl`
| String! |
Web URL of the epic
|
## EpicDescendantCount
## EpicDescendantCount
...
...
ee/app/graphql/types/epic_type.rb
View file @
e45bf70d
...
@@ -83,14 +83,26 @@ module Types
...
@@ -83,14 +83,26 @@ module Types
description:
'Indicates if the epic has direct issues'
,
description:
'Indicates if the epic has direct issues'
,
method: :has_issues?
method: :has_issues?
field
:web_path
,
GraphQL
::
STRING_TYPE
,
null:
false
,
method: :group_epic_path
# rubocop:disable Graphql/Descriptions
field
:web_path
,
GraphQL
::
STRING_TYPE
,
null:
false
,
field
:web_url
,
GraphQL
::
STRING_TYPE
,
null:
false
,
method: :group_epic_url
# rubocop:disable Graphql/Descriptions
description:
'Web path of the epic'
,
method: :group_epic_path
field
:web_url
,
GraphQL
::
STRING_TYPE
,
null:
false
,
description:
'Web URL of the epic'
,
method: :group_epic_url
field
:relative_position
,
GraphQL
::
INT_TYPE
,
null:
true
,
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
,
method: :group_epic_link_path
# rubocop:disable Graphql/Descriptions
field
:relation_path
,
GraphQL
::
STRING_TYPE
,
null:
true
,
field
:reference
,
GraphQL
::
STRING_TYPE
,
null:
false
,
method: :epic_reference
do
# rubocop:disable Graphql/Descriptions
description:
'URI path of the epic-issue relationship'
,
argument
:full
,
GraphQL
::
BOOLEAN_TYPE
,
required:
false
,
default_value:
false
# rubocop:disable Graphql/Descriptions
method: :group_epic_link_path
field
:reference
,
GraphQL
::
STRING_TYPE
,
null:
false
,
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'
end
end
field
:participants
,
Types
::
UserType
.
connection_type
,
null:
true
,
field
:participants
,
Types
::
UserType
.
connection_type
,
null:
true
,
description:
'List of participants for the epic'
,
description:
'List of participants for the epic'
,
complexity:
5
complexity:
5
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment