Merge branch 'cablett-backfilling-part-3-docs' into 'master'

Backfill GraphQL type descriptions (part 3)

See merge request gitlab-org/gitlab!21536

app/graphql/resolvers/echo_resolver.rb

@@ -2,9 +2,11 @@
 
 module Resolvers
   class EchoResolver < BaseResolver
-    argument    :text, GraphQL::STRING_TYPE, required: true # rubocop:disable Graphql/Descriptions
     description 'Testing endpoint to validate the API with'
 
+    argument    :text, GraphQL::STRING_TYPE, required: true,
+                description: 'Text to echo back'
+
     def resolve(**args)
       username = context[:current_user]&.username
 

app/graphql/resolvers/issues_resolver.rb

@@ -4,17 +4,17 @@ module Resolvers
   class IssuesResolver < BaseResolver
     argument :iid, GraphQL::STRING_TYPE,
               required: false,
-              description: 'The IID of the issue, e.g., "1"'
+              description: 'IID of the issue. For example, "1"'
 
     argument :iids, [GraphQL::STRING_TYPE],
               required: false,
-              description: 'The list of IIDs of issues, e.g., [1, 2]'
+              description: 'List of IIDs of issues. For example, [1, 2]'
     argument :state, Types::IssuableStateEnum,
               required: false,
-              description: 'Current state of Issue'
+              description: 'Current state of this issue'
     argument :label_name, GraphQL::STRING_TYPE.to_list_type,
               required: false,
-              description: 'Labels applied to the Issue'
+              description: 'Labels applied to this issue'
     argument :created_before, Types::TimeType,
               required: false,
               description: 'Issues created before this date'
@@ -33,8 +33,9 @@ module Resolvers
     argument :closed_after, Types::TimeType,
               required: false,
               description: 'Issues closed after this date'
-    argument :search, GraphQL::STRING_TYPE, # rubocop:disable Graphql/Descriptions
-              required: false
+    argument :search, GraphQL::STRING_TYPE,
+              required: false,
+              description: 'Search query for finding issues by title or description'
     argument :sort, Types::IssueSortEnum,
               description: 'Sort issues by this criteria',
               required: false,

app/graphql/types/diff_refs_type.rb

@@ -6,9 +6,12 @@ module Types
   class DiffRefsType < BaseObject
     graphql_name 'DiffRefs'
 
-    field :head_sha, GraphQL::STRING_TYPE, null: false, description: 'The sha of the head at the time the comment was made'
-    field :base_sha, GraphQL::STRING_TYPE, null: false, description: 'The merge base of the branch the comment was made on'
-    field :start_sha, GraphQL::STRING_TYPE, null: false, description: 'The sha of the branch being compared against'
+    field :head_sha, GraphQL::STRING_TYPE, null: false,
+          description: 'SHA of the HEAD at the time the comment was made'
+    field :base_sha, GraphQL::STRING_TYPE, null: false,
+          description: 'Merge base of the branch the comment was made on'
+    field :start_sha, GraphQL::STRING_TYPE, null: false,
+          description: 'SHA of the branch being compared against'
   end
   # rubocop: enable Graphql/AuthorizeTypes
 end

app/graphql/types/notes/diff_position_type.rb

@@ -7,36 +7,38 @@ module Types
     class DiffPositionType < BaseObject
       graphql_name 'DiffPosition'
 
-      field :diff_refs, Types::DiffRefsType, null: false # rubocop:disable Graphql/Descriptions
+      field :diff_refs, Types::DiffRefsType, null: false,
+            description: 'Information about the branch, HEAD, and base at the time of commenting'
 
       field :file_path, GraphQL::STRING_TYPE, null: false,
-            description: "The path of the file that was changed"
+            description: 'Path of the file that was changed'
       field :old_path, GraphQL::STRING_TYPE, null: true,
-            description: "The path of the file on the start sha."
+            description: 'Path of the file on the start SHA'
       field :new_path, GraphQL::STRING_TYPE, null: true,
-            description: "The path of the file on the head sha."
-      field :position_type, Types::Notes::PositionTypeEnum, null: false # rubocop:disable Graphql/Descriptions
+            description: 'Path of the file on the HEAD SHA'
+      field :position_type, Types::Notes::PositionTypeEnum, null: false,
+            description: 'Type of file the position refers to'
 
       # Fields for text positions
       field :old_line, GraphQL::INT_TYPE, null: true,
-            description: "The line on start sha that was changed",
+            description: 'Line on start SHA that was changed',
             resolve: -> (position, _args, _ctx) { position.old_line if position.on_text? }
       field :new_line, GraphQL::INT_TYPE, null: true,
-            description: "The line on head sha that was changed",
+            description: 'Line on HEAD SHA that was changed',
             resolve: -> (position, _args, _ctx) { position.new_line if position.on_text? }
 
       # Fields for image positions
       field :x, GraphQL::INT_TYPE, null: true,
-            description: "The X postion on which the comment was made",
+            description: 'X position on which the comment was made',
             resolve: -> (position, _args, _ctx) { position.x if position.on_image? }
       field :y, GraphQL::INT_TYPE, null: true,
-            description: "The Y position on which the comment was made",
+            description: 'Y position on which the comment was made',
             resolve: -> (position, _args, _ctx) { position.y if position.on_image? }
       field :width, GraphQL::INT_TYPE, null: true,
-            description: "The total width of the image",
+            description: 'Total width of the image',
             resolve: -> (position, _args, _ctx) { position.width if position.on_image? }
       field :height, GraphQL::INT_TYPE, null: true,
-            description: "The total height of the image",
+            description: 'Total height of the image',
             resolve: -> (position, _args, _ctx) { position.height if position.on_image? }
     end
     # rubocop: enable Graphql/AuthorizeTypes

app/graphql/types/notes/discussion_type.rb

@@ -7,10 +7,14 @@ module Types
 
       authorize :read_note
 
-      field :id, GraphQL::ID_TYPE, null: false # rubocop:disable Graphql/Descriptions
-      field :reply_id, GraphQL::ID_TYPE, null: false, description: 'The ID used to reply to this discussion'
-      field :created_at, Types::TimeType, null: false # rubocop:disable Graphql/Descriptions
-      field :notes, Types::Notes::NoteType.connection_type, null: false, description: "All notes in the discussion"
+      field :id, GraphQL::ID_TYPE, null: false,
+            description: "ID of this discussion"
+      field :reply_id, GraphQL::ID_TYPE, null: false,
+            description: 'ID used to reply to this discussion'
+      field :created_at, Types::TimeType, null: false,
+            description: "Timestamp of the discussion's creation"
+      field :notes, Types::Notes::NoteType.connection_type, null: false,
+            description: 'All notes in the discussion'
 
       # The gem we use to generate Global IDs is hard-coded to work with
       # `id` properties. To generate a GID for the `reply_id` property,

app/graphql/types/notes/note_type.rb

@@ -9,40 +9,48 @@ module Types
 
       expose_permissions Types::PermissionTypes::Note
 
-      field :id, GraphQL::ID_TYPE, null: false # rubocop:disable Graphql/Descriptions
+      field :id, GraphQL::ID_TYPE, null: false,
+            description: 'ID of the note'
 
       field :project, Types::ProjectType,
             null: true,
-            description: "The project this note is associated to",
+            description: 'Project associated with the note',
             resolve: -> (note, args, context) { Gitlab::Graphql::Loaders::BatchModelLoader.new(Project, note.project_id).find }
 
       field :author, Types::UserType,
             null: false,
-            description: "The user who wrote this note",
+            description: 'User who wrote this note',
             resolve: -> (note, args, context) { Gitlab::Graphql::Loaders::BatchModelLoader.new(User, note.author_id).find }
 
       field :resolved_by, Types::UserType,
             null: true,
-            description: "The user that resolved the discussion",
+            description: 'User that resolved the discussion',
             resolve: -> (note, _args, _context) { Gitlab::Graphql::Loaders::BatchModelLoader.new(User, note.resolved_by_id).find }
 
       field :system, GraphQL::BOOLEAN_TYPE,
             null: false,
-            description: "Whether or not this note was created by the system or by a user"
+            description: 'Indicates whether this note was created by the system or by a user'
 
       field :body, GraphQL::STRING_TYPE,
             null: false,
             method: :note,
-            description: "The content note itself"
+            description: 'Content of the note'
 
       markdown_field :body_html, null: true, method: :note
 
-      field :created_at, Types::TimeType, null: false # rubocop:disable Graphql/Descriptions
-      field :updated_at, Types::TimeType, null: false # rubocop:disable Graphql/Descriptions
-      field :discussion, Types::Notes::DiscussionType, null: true, description: "The discussion this note is a part of"
-      field :resolvable, GraphQL::BOOLEAN_TYPE, null: false, method: :resolvable? # rubocop:disable Graphql/Descriptions
-      field :resolved_at, Types::TimeType, null: true, description: "The time the discussion was resolved"
-      field :position, Types::Notes::DiffPositionType, null: true, description: "The position of this note on a diff"
+      field :created_at, Types::TimeType, null: false,
+            description: 'Timestamp of the note creation'
+      field :updated_at, Types::TimeType, null: false,
+            description: "Timestamp of the note's last activity"
+      field :discussion, Types::Notes::DiscussionType, null: true,
+            description: 'The discussion this note is a part of'
+      field :resolvable, GraphQL::BOOLEAN_TYPE, null: false,
+            description: 'Indicates if this note can be resolved. That is, if it is a resolvable discussion or simply a standalone note',
+            method: :resolvable?
+      field :resolved_at, Types::TimeType, null: true,
+            description: "Timestamp of the note's resolution"
+      field :position, Types::Notes::DiffPositionType, null: true,
+            description: 'The position of this note on a diff'
     end
   end
 end

app/graphql/types/query_type.rb

@@ -35,6 +35,8 @@ module Types
           resolver: Resolvers::SnippetsResolver,
           description: 'Find Snippets visible to the current user'
 
-    field :echo, GraphQL::STRING_TYPE, null: false, resolver: Resolvers::EchoResolver # rubocop:disable Graphql/Descriptions
+    field :echo, GraphQL::STRING_TYPE, null: false,
+          description: 'Text to echo back',
+          resolver: Resolvers::EchoResolver
   end
 end

doc/api/graphql/reference/index.md

@@ -178,33 +178,33 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
 
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
-| `diffRefs` | DiffRefs! |  |
-| `filePath` | String! | The path of the file that was changed |
-| `oldPath` | String | The path of the file on the start sha. |
-| `newPath` | String | The path of the file on the head sha. |
-| `positionType` | DiffPositionType! |  |
-| `oldLine` | Int | The line on start sha that was changed |
-| `newLine` | Int | The line on head sha that was changed |
-| `x` | Int | The X postion on which the comment was made |
-| `y` | Int | The Y position on which the comment was made |
-| `width` | Int | The total width of the image |
-| `height` | Int | The total height of the image |
+| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting |
+| `filePath` | String! | Path of the file that was changed |
+| `oldPath` | String | Path of the file on the start SHA |
+| `newPath` | String | Path of the file on the HEAD SHA |
+| `positionType` | DiffPositionType! | Type of file the position refers to |
+| `oldLine` | Int | Line on start SHA that was changed |
+| `newLine` | Int | Line on HEAD SHA that was changed |
+| `x` | Int | X position on which the comment was made |
+| `y` | Int | Y position on which the comment was made |
+| `width` | Int | Total width of the image |
+| `height` | Int | Total height of the image |
 
 ### DiffRefs
 
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
-| `headSha` | String! | The sha of the head at the time the comment was made |
-| `baseSha` | String! | The merge base of the branch the comment was made on |
-| `startSha` | String! | The sha of the branch being compared against |
+| `headSha` | String! | SHA of the HEAD at the time the comment was made |
+| `baseSha` | String! | Merge base of the branch the comment was made on |
+| `startSha` | String! | SHA of the branch being compared against |
 
 ### Discussion
 
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
-| `id` | ID! |  |
-| `replyId` | ID! | The ID used to reply to this discussion |
-| `createdAt` | Time! |  |
+| `id` | ID! | ID of this discussion |
+| `replyId` | ID! | ID used to reply to this discussion |
+| `createdAt` | Time! | Timestamp of the discussion's creation |
 
 ### Epic
 
@@ -281,13 +281,13 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
 | `createdAt` | Time! | Timestamp of when the issue was created |
 | `updatedAt` | Time! | Timestamp of when the issue was last updated |
 | `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
-| `epic` | Epic | The epic to which issue belongs |
-| `weight` | Int |  |
-| `designs` | DesignCollection |  |
-| `designCollection` | DesignCollection |  |
-| `epicIssueId` | ID! |  |
-| `relationPath` | String |  |
-| `id` | ID | The global id of the epic-issue relation |
+| `epic` | Epic | Epic to which this issue belongs |
+| `weight` | Int | Weight of the issue |
+| `designs` | DesignCollection | Deprecated. Use `design_collection`. |
+| `designCollection` | DesignCollection | Collection of design images associated with this issue |
+| `epicIssueId` | ID! | ID of the epic-issue relation |
+| `relationPath` | String | URI path of the epic-issue relation |
+| `id` | ID | Global ID of the epic-issue relation |
 
 ### EpicPermissions
 
@@ -338,7 +338,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
 | `parent` | Group | Parent group |
 | `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
 | `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |
-| `epic` | Epic |  |
+| `epic` | Epic | Find a single epic |
 
 ### GroupPermissions
 
@@ -376,10 +376,10 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
 | `createdAt` | Time! | Timestamp of when the issue was created |
 | `updatedAt` | Time! | Timestamp of when the issue was last updated |
 | `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
-| `epic` | Epic | The epic to which issue belongs |
-| `weight` | Int |  |
-| `designs` | DesignCollection |  |
-| `designCollection` | DesignCollection |  |
+| `epic` | Epic | Epic to which this issue belongs |
+| `weight` | Int | Weight of the issue |
+| `designs` | DesignCollection | Deprecated. Use `design_collection`. |
+| `designCollection` | DesignCollection | Collection of design images associated with this issue |
 
 ### IssuePermissions
 
@@ -577,18 +577,18 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
 | `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
-| `id` | ID! |  |
-| `project` | Project | The project this note is associated to |
-| `author` | User! | The user who wrote this note |
-| `resolvedBy` | User | The user that resolved the discussion |
-| `system` | Boolean! | Whether or not this note was created by the system or by a user |
-| `body` | String! | The content note itself |
+| `id` | ID! | ID of the note |
+| `project` | Project | Project associated with the note |
+| `author` | User! | User who wrote this note |
+| `resolvedBy` | User | User that resolved the discussion |
+| `system` | Boolean! | Indicates whether this note was created by the system or by a user |
+| `body` | String! | Content of the note |
 | `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
-| `createdAt` | Time! |  |
-| `updatedAt` | Time! |  |
+| `createdAt` | Time! | Timestamp of the note creation |
+| `updatedAt` | Time! | Timestamp of the note's last activity |
 | `discussion` | Discussion | The discussion this note is a part of |
-| `resolvable` | Boolean! |  |
-| `resolvedAt` | Time | The time the discussion was resolved |
+| `resolvable` | Boolean! | Indicates if this note can be resolved. That is, if it is a resolvable discussion or simply a standalone note |
+| `resolvedAt` | Time | Timestamp of the note's resolution |
 | `position` | DiffPosition | The position of this note on a diff |
 
 ### NotePermissions

ee/app/graphql/ee/types/group_type.rb

@@ -12,22 +12,19 @@ module EE
           end, description: "Indicates if #{feature.to_s.humanize} are enabled for namespace"
         end
 
-        field :epic, # rubocop:disable Graphql/Descriptions
-              ::Types::EpicType,
-              null: true,
+        field :epic, ::Types::EpicType, null: true,
+              description: 'Find a single epic',
               resolver: ::Resolvers::EpicResolver.single
 
-        field :epics, # rubocop:disable Graphql/Descriptions
-              ::Types::EpicType.connection_type,
-              null: true,
+        field :epics, ::Types::EpicType.connection_type, null: true,
+              description: 'Find epics',
               max_page_size: 2000,
               resolver: ::Resolvers::EpicResolver
 
-        field :timelogs,
-              ::Types::TimelogType.connection_type,
-              null: false, complexity: 5,
-              resolver: ::Resolvers::TimelogResolver,
-              description: 'Time logged in issues by group members'
+        field :timelogs, ::Types::TimelogType.connection_type, null: false,
+              description: 'Time logged in issues by group members',
+              complexity: 5,
+              resolver: ::Resolvers::TimelogResolver
       end
     end
   end

ee/app/graphql/ee/types/issue_type.rb

@@ -6,17 +6,20 @@ module EE
       extend ActiveSupport::Concern
 
       prepended do
-        field :epic, ::Types::EpicType, null: true, description: 'The epic to which issue belongs'
+        field :epic, ::Types::EpicType, null: true,
+              description: 'Epic to which this issue belongs'
 
-        field :weight, GraphQL::INT_TYPE, # rubocop:disable Graphql/Descriptions
-              null: true,
+        field :weight, GraphQL::INT_TYPE, null: true,
+              description: 'Weight of the issue',
               resolve: -> (obj, _args, _ctx) { obj.supports_weight? ? obj.weight : nil }
 
-        field :designs, ::Types::DesignManagement::DesignCollectionType, # rubocop:disable Graphql/Descriptions
-              null: true, method: :design_collection,
+        field :designs, ::Types::DesignManagement::DesignCollectionType, null: true,
+              description: "Deprecated. Use `design_collection`.",
+              method: :design_collection,
               deprecation_reason: 'use design_collection'
 
-        field :design_collection, ::Types::DesignManagement::DesignCollectionType, null: true # rubocop:disable Graphql/Descriptions
+        field :design_collection, ::Types::DesignManagement::DesignCollectionType, null: true,
+              description: 'Collection of design images associated with this issue'
       end
     end
   end

ee/app/graphql/resolvers/epic_resolver.rb

@@ -4,11 +4,11 @@ module Resolvers
   class EpicResolver < BaseResolver
     argument :iid, GraphQL::ID_TYPE,
              required: false,
-             description: 'The IID of the epic, e.g., "1"'
+             description: 'IID of the epic, e.g., "1"'
 
     argument :iids, [GraphQL::ID_TYPE],
              required: false,
-             description: 'The list of IIDs of epics, e.g., [1, 2]'
+             description: 'List of IIDs of epics, e.g., [1, 2]'
 
     argument :state, Types::EpicStateEnum,
              required: false,

ee/app/graphql/types/epic_issue_type.rb

@@ -8,15 +8,18 @@ module Types
 
     present_using EpicIssuePresenter
 
-    field :epic_issue_id, GraphQL::ID_TYPE, null: false # rubocop:disable Graphql/Descriptions
+    field :epic_issue_id, GraphQL::ID_TYPE, null: false,
+          description: 'ID of the epic-issue relation'
 
-    field :relation_path, GraphQL::STRING_TYPE, null: true, resolve: -> (issue, args, ctx) do # rubocop:disable Graphql/Descriptions
+    field :relation_path, GraphQL::STRING_TYPE, null: true,
+          description: 'URI path of the epic-issue relation',
+          resolve: -> (issue, args, ctx) do
             issue.group_epic_issue_path(ctx[:current_user])
           end
 
     field :id, GraphQL::ID_TYPE, null: true, resolve: -> (issue, args, ctx) do
       issue.to_global_id
-    end, description: 'The global id of the epic-issue relation'
+    end, description: 'Global ID of the epic-issue relation'
 
     def epic_issue_id
       "gid://gitlab/EpicIssue/#{object.epic_issue_id}"