Merge branch '31645-backfill-graphQL-type-field-descriptions-6' into 'master'

Backfill GraphQL descriptions (Part 7)

See merge request gitlab-org/gitlab!24716

doc/api/graphql/reference/gitlab_schema.graphql

@@ -1986,7 +1986,20 @@ type Epic implements Noteable {
     """
     last: Int
   ): 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
 
   """
@@ -2043,7 +2056,15 @@ type Epic implements Noteable {
   Permissions for the current user on the resource
   """
   userPermissions: EpicPermissions!
+
+  """
+  Web path of the epic
+  """
   webPath: String!
+
+  """
+  Web URL of the epic
+  """
   webUrl: String!
 }
 

doc/api/graphql/reference/gitlab_schema.json

@@ -5013,11 +5013,11 @@
             },
             {
               "name": "reference",
-              "description": null,
+              "description": "Internal reference of the epic. Returned in shortened format by default",
               "args": [
                 {
                   "name": "full",
-                  "description": null,
+                  "description": "Indicates if the reference should be returned in full",
                   "type": {
                     "kind": "SCALAR",
                     "name": "Boolean",
@@ -5040,7 +5040,7 @@
             },
             {
               "name": "relationPath",
-              "description": null,
+              "description": "URI path of the epic-issue relationship",
               "args": [
 
               ],
@@ -5224,7 +5224,7 @@
             },
             {
               "name": "webPath",
-              "description": null,
+              "description": "Web path of the epic",
               "args": [
 
               ],
@@ -5242,7 +5242,7 @@
             },
             {
               "name": "webUrl",
-              "description": null,
+              "description": "Web URL of the epic",
               "args": [
 
               ],

doc/api/graphql/reference/index.md

@@ -295,8 +295,8 @@ Represents an epic.
 | `id` | ID! | ID of the epic |
 | `iid` | ID! | Internal ID of the epic |
 | `parent` | Epic | Parent epic of the epic |
-| `reference` | String! |  |
-| `relationPath` | String |  |
+| `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 |
@@ -308,8 +308,8 @@ Represents an epic.
 | `updatedAt` | Time | Timestamp of the epic's last activity |
 | `upvotes` | Int! | Number of upvotes the epic has received |
 | `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
-| `webPath` | String! |  |
-| `webUrl` | String! |  |
+| `webPath` | String! | Web path of the epic |
+| `webUrl` | String! | Web URL of the epic |
 
 ## EpicDescendantCount
 

ee/app/graphql/types/epic_type.rb

@@ -83,14 +83,26 @@ module Types
           description: 'Indicates if the epic has direct issues',
           method: :has_issues?
 
-    field :web_path, GraphQL::STRING_TYPE, null: false, method: :group_epic_path # rubocop:disable Graphql/Descriptions
-    field :web_url, GraphQL::STRING_TYPE, null: false, method: :group_epic_url # rubocop:disable Graphql/Descriptions
+    field :web_path, GraphQL::STRING_TYPE, null: false,
+          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,
           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 :reference, GraphQL::STRING_TYPE, null: false, method: :epic_reference do # rubocop:disable Graphql/Descriptions
-      argument :full, GraphQL::BOOLEAN_TYPE, required: false, default_value: false # rubocop:disable Graphql/Descriptions
+    field :relation_path, GraphQL::STRING_TYPE, null: true,
+           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',
+    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
+
     field :participants, Types::UserType.connection_type, null: true,
           description: 'List of participants for the epic',
           complexity: 5