Merge branch 'ld-graphql-docs-add-dots' into 'master'

Add . to end of auto-generated GraphQL docs

See merge request gitlab-org/gitlab!42172

app/graphql/types/admin/sidekiq_queues/delete_jobs_response_type.rb

@@ -7,7 +7,7 @@ module Types
       # a plain hash.
       class DeleteJobsResponseType < BaseObject # rubocop:disable Graphql/AuthorizeTypes
         graphql_name 'DeleteJobsResponse'
-        description 'The response from the AdminSidekiqQueuesDeleteJobs mutation.'
+        description 'The response from the AdminSidekiqQueuesDeleteJobs mutation'
 
         field :completed,
               GraphQL::BOOLEAN_TYPE,

app/graphql/types/award_emojis/award_emoji_type.rb

@@ -4,7 +4,7 @@ module Types
   module AwardEmojis
     class AwardEmojiType < BaseObject
       graphql_name 'AwardEmoji'
-      description 'An emoji awarded by a user.'
+      description 'An emoji awarded by a user'
 
       authorize :read_emoji
 

app/graphql/types/design_management/design_at_version_type.rb

@@ -6,7 +6,7 @@ module Types
       graphql_name 'DesignAtVersion'
 
       description 'A design pinned to a specific version. ' \
-                  'The image field reflects the design as of the associated version.'
+                  'The image field reflects the design as of the associated version'
 
       authorize :read_design
 
@@ -23,7 +23,7 @@ module Types
       field :design,
             Types::DesignManagement::DesignType,
             null: false,
-            description: 'The underlying design.'
+            description: 'The underlying design'
 
       def cached_stateful_version(_parent)
         version

app/graphql/types/design_management/design_collection_type.rb

@@ -4,7 +4,7 @@ module Types
   module DesignManagement
     class DesignCollectionType < BaseObject
       graphql_name 'DesignCollection'
-      description 'A collection of designs.'
+      description 'A collection of designs'
 
       authorize :read_design
 

app/graphql/types/error_tracking/sentry_detailed_error_type.rb

@@ -4,7 +4,7 @@ module Types
   module ErrorTracking
     class SentryDetailedErrorType < ::Types::BaseObject
       graphql_name 'SentryDetailedError'
-      description 'A Sentry error.'
+      description 'A Sentry error'
 
       present_using SentryErrorPresenter
 

app/graphql/types/error_tracking/sentry_error_collection_type.rb

@@ -4,7 +4,7 @@ module Types
   module ErrorTracking
     class SentryErrorCollectionType < ::Types::BaseObject
       graphql_name 'SentryErrorCollection'
-      description 'An object containing a collection of Sentry errors, and a detailed error.'
+      description 'An object containing a collection of Sentry errors, and a detailed error'
 
       authorize :read_sentry_issue
 
@@ -21,7 +21,7 @@ module Types
                       required: false
               argument :sort,
                       String,
-                      description: 'Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default.',
+                      description: 'Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default',
                       required: false
             end
       field :detailed_error, Types::ErrorTracking::SentryDetailedErrorType,

app/graphql/types/error_tracking/sentry_error_stack_trace_entry_type.rb

@@ -5,7 +5,7 @@ module Types
     # rubocop: disable Graphql/AuthorizeTypes
     class SentryErrorStackTraceEntryType < ::Types::BaseObject
       graphql_name 'SentryErrorStackTraceEntry'
-      description 'An object containing a stack trace entry for a Sentry error.'
+      description 'An object containing a stack trace entry for a Sentry error'
 
       field :function, GraphQL::STRING_TYPE,
             null: true,

app/graphql/types/error_tracking/sentry_error_stack_trace_type.rb

@@ -4,7 +4,7 @@ module Types
   module ErrorTracking
     class SentryErrorStackTraceType < ::Types::BaseObject
       graphql_name 'SentryErrorStackTrace'
-      description 'An object containing a stack trace entry for a Sentry error.'
+      description 'An object containing a stack trace entry for a Sentry error'
 
       authorize :read_sentry_issue
 

app/graphql/types/error_tracking/sentry_error_type.rb

@@ -5,7 +5,7 @@ module Types
     # rubocop: disable Graphql/AuthorizeTypes
     class SentryErrorType < ::Types::BaseObject
       graphql_name 'SentryError'
-      description 'A Sentry error. A simplified version of SentryDetailedError.'
+      description 'A Sentry error. A simplified version of SentryDetailedError'
 
       present_using SentryErrorPresenter
 

app/graphql/types/issue_status_counts_type.rb

@@ -3,7 +3,7 @@
 module Types
   class IssueStatusCountsType < BaseObject
     graphql_name 'IssueStatusCountsType'
-    description "Represents total number of issues for the represented statuses."
+    description 'Represents total number of issues for the represented statuses'
 
     authorize :read_issue
 

app/graphql/types/milestone_type.rb

@@ -3,7 +3,7 @@
 module Types
   class MilestoneType < BaseObject
     graphql_name 'Milestone'
-    description 'Represents a milestone.'
+    description 'Represents a milestone'
 
     present_using MilestonePresenter
 

app/graphql/types/mutation_operation_mode_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class MutationOperationModeEnum < BaseEnum
     graphql_name 'MutationOperationMode'
-    description 'Different toggles for changing mutator behavior.'
+    description 'Different toggles for changing mutator behavior'
 
     # Suggested param name for the enum: `operation_mode`
 

doc/api/graphql/reference/gitlab_schema.graphql

@@ -731,7 +731,7 @@ type AlertTodoCreatePayload {
 }
 
 """
-An emoji awarded by a user.
+An emoji awarded by a user
 """
 type AwardEmoji {
   """
@@ -1448,7 +1448,7 @@ type Branch {
 }
 
 """
-Represents the total number of issues and their weights for a particular day.
+Represents the total number of issues and their weights for a particular day
 """
 type BurnupChartDailyTotals {
   """
@@ -3139,7 +3139,7 @@ enum DastScanTypeEnum {
 }
 
 """
-Represents a DAST scanner profile.
+Represents a DAST scanner profile
 """
 type DastScannerProfile {
   """
@@ -3359,7 +3359,7 @@ type DastScannerProfileUpdatePayload {
 }
 
 """
-Represents a DAST Site Profile.
+Represents a DAST Site Profile
 """
 type DastSiteProfile {
   """
@@ -3626,7 +3626,7 @@ type DeleteAnnotationPayload {
 }
 
 """
-The response from the AdminSidekiqQueuesDeleteJobs mutation.
+The response from the AdminSidekiqQueuesDeleteJobs mutation
 """
 type DeleteJobsResponse {
   """
@@ -3816,11 +3816,11 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
 }
 
 """
-A design pinned to a specific version. The image field reflects the design as of the associated version.
+A design pinned to a specific version. The image field reflects the design as of the associated version
 """
 type DesignAtVersion implements DesignFields {
   """
-  The underlying design.
+  The underlying design
   """
   design: Design!
 
@@ -3916,7 +3916,7 @@ type DesignAtVersionEdge {
 }
 
 """
-A collection of designs.
+A collection of designs
 """
 type DesignCollection {
   """
@@ -5106,7 +5106,7 @@ type EnvironmentEdge {
 }
 
 """
-Represents an epic.
+Represents an epic
 """
 type Epic implements CurrentUserTodos & Noteable {
   """
@@ -5603,7 +5603,7 @@ type EpicConnection {
 }
 
 """
-Counts of descendent epics.
+Counts of descendent epics
 """
 type EpicDescendantCount {
   """
@@ -6203,7 +6203,7 @@ enum EpicSort {
 }
 
 """
-State of an epic.
+State of an epic
 """
 enum EpicState {
   all
@@ -8703,7 +8703,7 @@ enum IssueState {
 }
 
 """
-Represents total number of issues for the represented statuses.
+Represents total number of issues for the represented statuses
 """
 type IssueStatusCountsType {
   """
@@ -8743,7 +8743,7 @@ enum IssueType {
 }
 
 """
-Represents an iteration object.
+Represents an iteration object
 """
 type Iteration implements TimeboxBurnupTimeSeriesInterface {
   """
@@ -10606,7 +10606,7 @@ type MetricsDashboardAnnotationEdge {
 }
 
 """
-Represents a milestone.
+Represents a milestone
 """
 type Milestone implements TimeboxBurnupTimeSeriesInterface {
   """
@@ -10868,7 +10868,7 @@ type Mutation {
 }
 
 """
-Different toggles for changing mutator behavior.
+Different toggles for changing mutator behavior
 """
 enum MutationOperationMode {
   """
@@ -14236,7 +14236,7 @@ type Query {
 }
 
 """
-State of a Geo registry.
+State of a Geo registry
 """
 enum RegistryState {
   """
@@ -14968,7 +14968,7 @@ enum RequirementState {
 }
 
 """
-Counts of requirements by their state.
+Counts of requirements by their state
 """
 type RequirementStatesCount {
   """
@@ -15556,7 +15556,7 @@ type SecurityReportSummarySection {
 }
 
 """
-The type of the security scanner.
+The type of the security scanner
 """
 enum SecurityScannerType {
   CONTAINER_SCANNING
@@ -15588,7 +15588,7 @@ type SecurityScanners {
 }
 
 """
-A Sentry error.
+A Sentry error
 """
 type SentryDetailedError {
   """
@@ -15733,7 +15733,7 @@ type SentryDetailedError {
 }
 
 """
-A Sentry error. A simplified version of SentryDetailedError.
+A Sentry error. A simplified version of SentryDetailedError
 """
 type SentryError {
   """
@@ -15823,7 +15823,7 @@ type SentryError {
 }
 
 """
-An object containing a collection of Sentry errors, and a detailed error.
+An object containing a collection of Sentry errors, and a detailed error
 """
 type SentryErrorCollection {
   """
@@ -15876,7 +15876,7 @@ type SentryErrorCollection {
     searchTerm: String
 
     """
-    Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default.
+    Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default
     """
     sort: String
   ): SentryErrorConnection
@@ -15935,7 +15935,7 @@ type SentryErrorFrequency {
 }
 
 """
-An object containing a stack trace entry for a Sentry error.
+An object containing a stack trace entry for a Sentry error
 """
 type SentryErrorStackTrace {
   """
@@ -15970,7 +15970,7 @@ type SentryErrorStackTraceContext {
 }
 
 """
-An object containing a stack trace entry for a Sentry error.
+An object containing a stack trace entry for a Sentry error
 """
 type SentryErrorStackTraceEntry {
   """
@@ -16670,7 +16670,7 @@ type TerraformStateRegistryEdge {
 }
 
 """
-Represents a requirement test report.
+Represents a requirement test report
 """
 type TestReport {
   """
@@ -18623,7 +18623,7 @@ type VulnerabilitiesCountByDayEdge {
 }
 
 """
-Represents a vulnerability.
+Represents a vulnerability
 """
 type Vulnerability {
   """
@@ -18786,7 +18786,7 @@ enum VulnerabilityGrade {
 }
 
 """
-Represents a vulnerability identifier.
+Represents a vulnerability identifier
 """
 type VulnerabilityIdentifier {
   """
@@ -18811,7 +18811,7 @@ type VulnerabilityIdentifier {
 }
 
 """
-Represents an issue link of a vulnerability.
+Represents an issue link of a vulnerability
 """
 type VulnerabilityIssueLink {
   """
@@ -18866,7 +18866,7 @@ type VulnerabilityIssueLinkEdge {
 }
 
 """
-The type of the issue link related to a vulnerability.
+The type of the issue link related to a vulnerability
 """
 enum VulnerabilityIssueLinkType {
   CREATED
@@ -19074,7 +19074,7 @@ type VulnerabilityPermissions {
 }
 
 """
-The type of the security scan that found the vulnerability.
+The type of the security scan that found the vulnerability
 """
 enum VulnerabilityReportType {
   CONTAINER_SCANNING
@@ -19086,7 +19086,7 @@ enum VulnerabilityReportType {
 }
 
 """
-Represents a vulnerability scanner.
+Represents a vulnerability scanner
 """
 type VulnerabilityScanner {
   """
@@ -19181,7 +19181,7 @@ type VulnerabilitySeveritiesCount {
 }
 
 """
-The severity of the vulnerability.
+The severity of the vulnerability
 """
 enum VulnerabilitySeverity {
   CRITICAL
@@ -19208,7 +19208,7 @@ enum VulnerabilitySort {
 }
 
 """
-The state of the vulnerability.
+The state of the vulnerability
 """
 enum VulnerabilityState {
   CONFIRMED

ee/app/graphql/types/burnup_chart_daily_totals_type.rb

@@ -4,7 +4,7 @@ module Types
   # rubocop: disable Graphql/AuthorizeTypes
   class BurnupChartDailyTotalsType < BaseObject
     graphql_name 'BurnupChartDailyTotals'
-    description 'Represents the total number of issues and their weights for a particular day.'
+    description 'Represents the total number of issues and their weights for a particular day'
 
     field :date, GraphQL::Types::ISO8601Date, null: false,
           description: 'Date for burnup totals'

ee/app/graphql/types/dast_scanner_profile_type.rb

@@ -3,7 +3,7 @@
 module Types
   class DastScannerProfileType < BaseObject
     graphql_name 'DastScannerProfile'
-    description 'Represents a DAST scanner profile.'
+    description 'Represents a DAST scanner profile'
 
     authorize :create_on_demand_dast_scan
 

ee/app/graphql/types/dast_site_profile_type.rb

@@ -3,7 +3,7 @@
 module Types
   class DastSiteProfileType < BaseObject
     graphql_name 'DastSiteProfile'
-    description 'Represents a DAST Site Profile.'
+    description 'Represents a DAST Site Profile'
 
     authorize :create_on_demand_dast_scan
 

ee/app/graphql/types/epic_descendant_count_type.rb

@@ -4,7 +4,7 @@ module Types
   # rubocop: disable Graphql/AuthorizeTypes
   class EpicDescendantCountType < BaseObject
     graphql_name 'EpicDescendantCount'
-    description 'Counts of descendent epics.'
+    description 'Counts of descendent epics'
 
     field :opened_epics, GraphQL::INT_TYPE, null: true, description: 'Number of opened child epics'
     field :closed_epics, GraphQL::INT_TYPE, null: true, description: 'Number of closed child epics'

ee/app/graphql/types/epic_state_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class EpicStateEnum < BaseEnum
     graphql_name 'EpicState'
-    description 'State of an epic.'
+    description 'State of an epic'
 
     value 'all'
     value 'opened'

ee/app/graphql/types/epic_type.rb

@@ -5,7 +5,7 @@ module Types
     include ::Gitlab::Graphql::Aggregations::Epics::Constants
 
     graphql_name 'Epic'
-    description 'Represents an epic.'
+    description 'Represents an epic'
 
     authorize :read_epic
 

ee/app/graphql/types/geo/registry_state_enum.rb

@@ -4,7 +4,7 @@ module Types
   module Geo
     class RegistryStateEnum < BaseEnum
       graphql_name 'RegistryState'
-      description 'State of a Geo registry.'
+      description 'State of a Geo registry'
 
       value 'PENDING', value: :pending, description: 'Registry waiting to be synced'
       value 'STARTED', value: :started, description: 'Registry currently syncing'

ee/app/graphql/types/iteration_type.rb

@@ -3,7 +3,7 @@
 module Types
   class IterationType < BaseObject
     graphql_name 'Iteration'
-    description 'Represents an iteration object.'
+    description 'Represents an iteration object'
 
     present_using IterationPresenter
 

ee/app/graphql/types/requirements_management/requirement_states_count_type.rb

@@ -5,7 +5,7 @@ module Types
     # rubocop: disable Graphql/AuthorizeTypes
     class RequirementStatesCountType < BaseObject
       graphql_name 'RequirementStatesCount'
-      description 'Counts of requirements by their state.'
+      description 'Counts of requirements by their state'
 
       field :opened, GraphQL::INT_TYPE, null: true, description: 'Number of opened requirements'
       field :archived, GraphQL::INT_TYPE, null: true, description: 'Number of archived requirements'

ee/app/graphql/types/requirements_management/test_report_type.rb

@@ -4,7 +4,7 @@ module Types
   module RequirementsManagement
     class TestReportType < BaseObject
       graphql_name 'TestReport'
-      description 'Represents a requirement test report.'
+      description 'Represents a requirement test report'
 
       authorize :read_requirement
 

ee/app/graphql/types/security_scanner_type_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class SecurityScannerTypeEnum < BaseEnum
     graphql_name 'SecurityScannerType'
-    description 'The type of the security scanner.'
+    description 'The type of the security scanner'
 
     ::Security::SecurityJobsFinder.allowed_job_types.each do |scanner|
       value scanner.upcase.to_s

ee/app/graphql/types/vulnerability/issue_link_type.rb

@@ -5,7 +5,7 @@ module Types
     # rubocop: disable Graphql/AuthorizeTypes
     class IssueLinkType < BaseObject
       graphql_name 'VulnerabilityIssueLink'
-      description 'Represents an issue link of a vulnerability.'
+      description 'Represents an issue link of a vulnerability'
 
       field :id, GraphQL::ID_TYPE, null: false,
             description: 'GraphQL ID of the vulnerability'

ee/app/graphql/types/vulnerability/issue_link_type_enum.rb

@@ -4,7 +4,7 @@ module Types
   module Vulnerability
     class IssueLinkTypeEnum < BaseEnum
       graphql_name 'VulnerabilityIssueLinkType'
-      description 'The type of the issue link related to a vulnerability.'
+      description 'The type of the issue link related to a vulnerability'
 
       ::Vulnerabilities::IssueLink.link_types.keys.each do |link_type|
         value link_type.to_s.upcase, value: link_type.to_s

ee/app/graphql/types/vulnerability_identifier_type.rb

@@ -4,7 +4,7 @@ module Types
   # rubocop: disable Graphql/AuthorizeTypes
   class VulnerabilityIdentifierType < BaseObject
     graphql_name 'VulnerabilityIdentifier'
-    description 'Represents a vulnerability identifier.'
+    description 'Represents a vulnerability identifier'
 
     field :name, GraphQL::STRING_TYPE, null: true,
           description: 'Name of the vulnerability identifier'

ee/app/graphql/types/vulnerability_report_type_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class VulnerabilityReportTypeEnum < BaseEnum
     graphql_name 'VulnerabilityReportType'
-    description 'The type of the security scan that found the vulnerability.'
+    description 'The type of the security scan that found the vulnerability'
 
     ::Vulnerabilities::Finding::REPORT_TYPES.keys.each do |report_type|
       value report_type.to_s.upcase, value: report_type.to_s

ee/app/graphql/types/vulnerability_scanner_type.rb

@@ -3,7 +3,7 @@
 module Types
   class VulnerabilityScannerType < BaseObject
     graphql_name 'VulnerabilityScanner'
-    description 'Represents a vulnerability scanner.'
+    description 'Represents a vulnerability scanner'
 
     authorize :read_vulnerability_scanner
 

ee/app/graphql/types/vulnerability_severity_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class VulnerabilitySeverityEnum < BaseEnum
     graphql_name 'VulnerabilitySeverity'
-    description 'The severity of the vulnerability.'
+    description 'The severity of the vulnerability'
 
     ::Vulnerabilities::Finding::SEVERITY_LEVELS.keys.each do |severity|
       value severity.to_s.upcase, value: severity.to_s

ee/app/graphql/types/vulnerability_state_enum.rb

@@ -3,7 +3,7 @@
 module Types
   class VulnerabilityStateEnum < BaseEnum
     graphql_name 'VulnerabilityState'
-    description 'The state of the vulnerability.'
+    description 'The state of the vulnerability'
 
     ::Vulnerability.states.keys.each do |state|
       value state.to_s.upcase, value: state.to_s

ee/app/graphql/types/vulnerability_type.rb

@@ -3,7 +3,7 @@
 module Types
   class VulnerabilityType < BaseObject
     graphql_name 'Vulnerability'
-    description 'Represents a vulnerability.'
+    description 'Represents a vulnerability'
 
     authorize :read_vulnerability
 

lib/gitlab/graphql/docs/helper.rb

@@ -25,7 +25,7 @@ module Gitlab
           content = "### #{object[:name]}\n"
 
           if object[:description].present?
-            content += "\n#{object[:description]}\n"
+            content += "\n#{object[:description]}.\n"
           end
 
           content