Merge branch 'aqualls-api-definition-spelling' into 'master'

Spelling fixes, API definitions

See merge request gitlab-org/gitlab!52951

app/graphql/types/alert_management/alert_type.rb

@@ -112,7 +112,7 @@ module Types
       field :todos,
             Types::TodoType.connection_type,
             null: true,
-            description: 'Todos of the current user for the alert.',
+            description: 'To-dos of the current user for the alert.',
             resolver: Resolvers::TodoResolver
 
       field :details_url,

app/graphql/types/award_emojis/award_emoji_type.rb

@@ -23,7 +23,7 @@ module Types
       field :unicode,
             GraphQL::STRING_TYPE,
             null: false,
-            description: 'The emoji in unicode.'
+            description: 'The emoji in Unicode.'
 
       field :emoji,
             GraphQL::STRING_TYPE,
@@ -33,7 +33,7 @@ module Types
       field :unicode_version,
             GraphQL::STRING_TYPE,
             null: false,
-            description: 'The unicode version for this emoji.'
+            description: 'The Unicode version for this emoji.'
 
       field :user,
             Types::UserType,

app/graphql/types/ci/config/config_type.rb

@@ -10,7 +10,7 @@ module Types
         field :errors, [GraphQL::STRING_TYPE], null: true,
               description: 'Linting errors.'
         field :merged_yaml, GraphQL::STRING_TYPE, null: true,
-              description: 'Merged CI config YAML.'
+              description: 'Merged CI configuration YAML.'
         field :stages, Types::Ci::Config::StageType.connection_type, null: true,
               description: 'Stages of the pipeline.'
         field :status, Types::Ci::Config::StatusEnum, null: true,

app/graphql/types/ci/pipeline_type.rb

@@ -31,7 +31,7 @@ module Types
             description: 'Detailed status of the pipeline.'
 
       field :config_source, PipelineConfigSourceEnum, null: true,
-            description: "Config source of the pipeline (#{::Enums::Ci::Pipeline.config_sources.keys.join(', ').upcase})"
+            description: "Configuration source of the pipeline (#{::Enums::Ci::Pipeline.config_sources.keys.join(', ').upcase})"
 
       field :duration, GraphQL::INT_TYPE, null: true,
             description: 'Duration of the pipeline in seconds.'

app/graphql/types/project_type.rb

@@ -112,7 +112,7 @@ module Types
     field :suggestion_commit_message, GraphQL::STRING_TYPE, null: true,
           description: 'The commit message used to apply merge request suggestions'
     field :squash_read_only, GraphQL::BOOLEAN_TYPE, null: false, method: :squash_readonly?,
-          description: 'Indicates if squash readonly is enabled'
+          description: 'Indicates if `squashReadOnly` is enabled'
 
     field :namespace, Types::NamespaceType, null: true,
           description: 'Namespace of the project'

app/graphql/types/snippets/blob_viewer_type.rb

@@ -11,7 +11,7 @@ module Types
             null: false
 
       field :load_async, GraphQL::BOOLEAN_TYPE,
-            description: 'Shows whether the blob content is loaded async',
+            description: 'Shows whether the blob content is loaded asynchronously',
             null: false
 
       field :collapsed, GraphQL::BOOLEAN_TYPE,

app/graphql/types/tree/entry_type.rb

@@ -7,7 +7,7 @@ module Types
       field :id, GraphQL::ID_TYPE, null: false,
             description: 'ID of the entry'
       field :sha, GraphQL::STRING_TYPE, null: false,
-            description: 'Last commit sha for the entry', method: :id
+            description: 'Last commit SHA for the entry', method: :id
       field :name, GraphQL::STRING_TYPE, null: false,
             description: 'Name of the entry'
       field :type, Tree::TypeEnum, null: false,

doc/api/graphql/reference/gitlab_schema.graphql

@@ -350,7 +350,7 @@ type AlertManagementAlert implements Noteable {
   title: String
 
   """
-  Todos of the current user for the alert.
+  To-dos of the current user for the alert.
   """
   todos(
     """
@@ -1092,12 +1092,12 @@ type AwardEmoji {
   name: String!
 
   """
-  The emoji in unicode.
+  The emoji in Unicode.
   """
   unicode: String!
 
   """
-  The unicode version for this emoji.
+  The Unicode version for this emoji.
   """
   unicodeVersion: String!
 
@@ -1287,7 +1287,7 @@ type Blob implements Entry {
   path: String!
 
   """
-  Last commit sha for the entry
+  Last commit SHA for the entry
   """
   sha: String!
 
@@ -2487,7 +2487,7 @@ type CiConfig {
   errors: [String!]
 
   """
-  Merged CI config YAML.
+  Merged CI configuration YAML.
   """
   mergedYaml: String
 
@@ -8180,7 +8180,7 @@ interface Entry {
   path: String!
 
   """
-  Last commit sha for the entry
+  Last commit SHA for the entry
   """
   sha: String!
 
@@ -11804,7 +11804,7 @@ type IncidentManagementOncallRotation {
   ): OncallParticipantTypeConnection
 
   """
-  Blocks of time for which a participant is on-call within a given timeframe. Timeframe cannot exceed one month.
+  Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.
   """
   shifts(
     """
@@ -17535,7 +17535,7 @@ type Pipeline {
   committedAt: Time
 
   """
-  Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE,
+  Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE,
   AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE,
   BRIDGE_SOURCE, PARAMETER_SOURCE)
   """
@@ -19605,7 +19605,7 @@ type Project {
   snippetsEnabled: Boolean
 
   """
-  Indicates if squash readonly is enabled
+  Indicates if `squashReadOnly` is enabled
   """
   squashReadOnly: Boolean!
 
@@ -22821,37 +22821,37 @@ Represents summary of a security report
 """
 type SecurityReportSummary {
   """
-  Aggregated counts for the api_fuzzing scan
+  Aggregated counts for the `api_fuzzing` scan
   """
   apiFuzzing: SecurityReportSummarySection
 
   """
-  Aggregated counts for the container_scanning scan
+  Aggregated counts for the `container_scanning` scan
   """
   containerScanning: SecurityReportSummarySection
 
   """
-  Aggregated counts for the coverage_fuzzing scan
+  Aggregated counts for the `coverage_fuzzing` scan
   """
   coverageFuzzing: SecurityReportSummarySection
 
   """
-  Aggregated counts for the dast scan
+  Aggregated counts for the `dast` scan
   """
   dast: SecurityReportSummarySection
 
   """
-  Aggregated counts for the dependency_scanning scan
+  Aggregated counts for the `dependency_scanning` scan
   """
   dependencyScanning: SecurityReportSummarySection
 
   """
-  Aggregated counts for the sast scan
+  Aggregated counts for the `sast` scan
   """
   sast: SecurityReportSummarySection
 
   """
-  Aggregated counts for the secret_detection scan
+  Aggregated counts for the `secret_detection` scan
   """
   secretDetection: SecurityReportSummarySection
 }
@@ -23824,7 +23824,7 @@ type SnippetBlobViewer {
   fileType: String!
 
   """
-  Shows whether the blob content is loaded async
+  Shows whether the blob content is loaded asynchronously
   """
   loadAsync: Boolean!
 
@@ -24095,7 +24095,7 @@ type Submodule implements Entry {
   path: String!
 
   """
-  Last commit sha for the entry
+  Last commit SHA for the entry
   """
   sha: String!
 
@@ -25135,7 +25135,7 @@ type TreeEntry implements Entry {
   path: String!
 
   """
-  Last commit sha for the entry
+  Last commit SHA for the entry
   """
   sha: String!
 

doc/api/graphql/reference/gitlab_schema.json

@@ -953,7 +953,7 @@
             },
             {
               "name": "todos",
-              "description": "Todos of the current user for the alert.",
+              "description": "To-dos of the current user for the alert.",
               "args": [
                 {
                   "name": "action",
@@ -2699,7 +2699,7 @@
             },
             {
               "name": "unicode",
-              "description": "The emoji in unicode.",
+              "description": "The emoji in Unicode.",
               "args": [
 
               ],
@@ -2717,7 +2717,7 @@
             },
             {
               "name": "unicodeVersion",
-              "description": "The unicode version for this emoji.",
+              "description": "The Unicode version for this emoji.",
               "args": [
 
               ],
@@ -3297,7 +3297,7 @@
             },
             {
               "name": "sha",
-              "description": "Last commit sha for the entry",
+              "description": "Last commit SHA for the entry",
               "args": [
 
               ],
@@ -6584,7 +6584,7 @@
             },
             {
               "name": "mergedYaml",
-              "description": "Merged CI config YAML.",
+              "description": "Merged CI configuration YAML.",
               "args": [
 
               ],
@@ -22659,7 +22659,7 @@
             },
             {
               "name": "sha",
-              "description": "Last commit sha for the entry",
+              "description": "Last commit SHA for the entry",
               "args": [
 
               ],
@@ -32232,7 +32232,7 @@
             },
             {
               "name": "shifts",
-              "description": "Blocks of time for which a participant is on-call within a given timeframe. Timeframe cannot exceed one month.",
+              "description": "Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.",
               "args": [
                 {
                   "name": "startTime",
@@ -51696,7 +51696,7 @@
             },
             {
               "name": "configSource",
-              "description": "Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE)",
+              "description": "Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE)",
               "args": [
 
               ],
@@ -56965,7 +56965,7 @@
             },
             {
               "name": "squashReadOnly",
-              "description": "Indicates if squash readonly is enabled",
+              "description": "Indicates if `squashReadOnly` is enabled",
               "args": [
 
               ],
@@ -65989,7 +65989,7 @@
           "fields": [
             {
               "name": "apiFuzzing",
-              "description": "Aggregated counts for the api_fuzzing scan",
+              "description": "Aggregated counts for the `api_fuzzing` scan",
               "args": [
 
               ],
@@ -66003,7 +66003,7 @@
             },
             {
               "name": "containerScanning",
-              "description": "Aggregated counts for the container_scanning scan",
+              "description": "Aggregated counts for the `container_scanning` scan",
               "args": [
 
               ],
@@ -66017,7 +66017,7 @@
             },
             {
               "name": "coverageFuzzing",
-              "description": "Aggregated counts for the coverage_fuzzing scan",
+              "description": "Aggregated counts for the `coverage_fuzzing` scan",
               "args": [
 
               ],
@@ -66031,7 +66031,7 @@
             },
             {
               "name": "dast",
-              "description": "Aggregated counts for the dast scan",
+              "description": "Aggregated counts for the `dast` scan",
               "args": [
 
               ],
@@ -66045,7 +66045,7 @@
             },
             {
               "name": "dependencyScanning",
-              "description": "Aggregated counts for the dependency_scanning scan",
+              "description": "Aggregated counts for the `dependency_scanning` scan",
               "args": [
 
               ],
@@ -66059,7 +66059,7 @@
             },
             {
               "name": "sast",
-              "description": "Aggregated counts for the sast scan",
+              "description": "Aggregated counts for the `sast` scan",
               "args": [
 
               ],
@@ -66073,7 +66073,7 @@
             },
             {
               "name": "secretDetection",
-              "description": "Aggregated counts for the secret_detection scan",
+              "description": "Aggregated counts for the `secret_detection` scan",
               "args": [
 
               ],
@@ -69101,7 +69101,7 @@
             },
             {
               "name": "loadAsync",
-              "description": "Shows whether the blob content is loaded async",
+              "description": "Shows whether the blob content is loaded asynchronously",
               "args": [
 
               ],
@@ -69912,7 +69912,7 @@
             },
             {
               "name": "sha",
-              "description": "Last commit sha for the entry",
+              "description": "Last commit SHA for the entry",
               "args": [
 
               ],
@@ -73124,7 +73124,7 @@
             },
             {
               "name": "sha",
-              "description": "Last commit sha for the entry",
+              "description": "Last commit SHA for the entry",
               "args": [
 
               ],

doc/api/graphql/reference/index.md

@@ -102,7 +102,7 @@ Describes an alert from the project's Alert Management.
 | `startedAt` | Time | Timestamp the alert was raised. |
 | `status` | AlertManagementStatus | Status of the alert. |
 | `title` | String | Title of the alert. |
-| `todos` | TodoConnection | Todos of the current user for the alert. |
+| `todos` | TodoConnection | To-dos of the current user for the alert. |
 | `updatedAt` | Time | Timestamp the alert was last updated. |
 
 ### AlertManagementAlertStatusCountsType
@@ -179,8 +179,8 @@ An emoji awarded by a user.
 | `description` | String! | The emoji description. |
 | `emoji` | String! | The emoji as an icon. |
 | `name` | String! | The emoji name. |
-| `unicode` | String! | The emoji in unicode. |
-| `unicodeVersion` | String! | The unicode version for this emoji. |
+| `unicode` | String! | The emoji in Unicode. |
+| `unicodeVersion` | String! | The Unicode version for this emoji. |
 | `user` | User! | The user who awarded the emoji. |
 
 ### AwardEmojiAddPayload
@@ -231,7 +231,7 @@ Autogenerated return type of AwardEmojiToggle.
 | `mode` | String | Blob mode in numeric format |
 | `name` | String! | Name of the entry |
 | `path` | String! | Path of the entry |
-| `sha` | String! | Last commit sha for the entry |
+| `sha` | String! | Last commit SHA for the entry |
 | `type` | EntryType! | Type of tree entry |
 | `webPath` | String | Web path of the blob |
 | `webUrl` | String | Web URL of the blob |
@@ -397,7 +397,7 @@ Autogenerated return type of CiCdSettingsUpdate.
 | Field | Type | Description |
 | ----- | ---- | ----------- |
 | `errors` | String! => Array | Linting errors. |
-| `mergedYaml` | String | Merged CI config YAML. |
+| `mergedYaml` | String | Merged CI configuration YAML. |
 | `stages` | CiConfigStageConnection | Stages of the pipeline. |
 | `status` | CiConfigStatus | Status of linting, can be either valid or invalid. |
 
@@ -1809,7 +1809,7 @@ Describes an incident management on-call rotation.
 | `lengthUnit` | OncallRotationUnitEnum | Unit of the on-call rotation length. |
 | `name` | String! | Name of the on-call rotation. |
 | `participants` | OncallParticipantTypeConnection | Participants of the on-call rotation. |
-| `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given timeframe. Timeframe cannot exceed one month. |
+| `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. |
 | `startsAt` | Time | Start date of the on-call rotation. |
 
 ### IncidentManagementOncallSchedule
@@ -2657,7 +2657,7 @@ Information about pagination in a connection..
 | `beforeSha` | String | Base SHA of the source branch. |
 | `cancelable` | Boolean! | Specifies if a pipeline can be canceled. |
 | `committedAt` | Time | Timestamp of the pipeline's commit. |
-| `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
+| `configSource` | PipelineConfigSourceEnum | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
 | `coverage` | Float | Coverage percentage. |
 | `createdAt` | Time! | Timestamp of the pipeline's creation. |
 | `detailedStatus` | DetailedStatus! | Detailed status of the pipeline. |
@@ -2826,7 +2826,7 @@ Autogenerated return type of PipelineRetry.
 | `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project |
 | `snippets` | SnippetConnection | Snippets of the project |
 | `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
-| `squashReadOnly` | Boolean! | Indicates if squash readonly is enabled |
+| `squashReadOnly` | Boolean! | Indicates if `squashReadOnly` is enabled |
 | `sshUrlToRepo` | String | URL to connect to the project via SSH |
 | `starCount` | Int! | Number of times the project has been starred |
 | `statistics` | ProjectStatistics | Statistics of the project |
@@ -3283,13 +3283,13 @@ Represents summary of a security report.
 
 | Field | Type | Description |
 | ----- | ---- | ----------- |
-| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the api_fuzzing scan |
-| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the container_scanning scan |
-| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the coverage_fuzzing scan |
-| `dast` | SecurityReportSummarySection | Aggregated counts for the dast scan |
-| `dependencyScanning` | SecurityReportSummarySection | Aggregated counts for the dependency_scanning scan |
-| `sast` | SecurityReportSummarySection | Aggregated counts for the sast scan |
-| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the secret_detection scan |
+| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the `api_fuzzing` scan |
+| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the `container_scanning` scan |
+| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the `coverage_fuzzing` scan |
+| `dast` | SecurityReportSummarySection | Aggregated counts for the `dast` scan |
+| `dependencyScanning` | SecurityReportSummarySection | Aggregated counts for the `dependency_scanning` scan |
+| `sast` | SecurityReportSummarySection | Aggregated counts for the `sast` scan |
+| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the `secret_detection` scan |
 
 ### SecurityReportSummarySection
 
@@ -3482,7 +3482,7 @@ Represents how the blob content should be displayed.
 | ----- | ---- | ----------- |
 | `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed |
 | `fileType` | String! | Content file type |
-| `loadAsync` | Boolean! | Shows whether the blob content is loaded async |
+| `loadAsync` | Boolean! | Shows whether the blob content is loaded asynchronously |
 | `loadingPartialName` | String! | Loading partial name |
 | `renderError` | String | Error rendering the blob content |
 | `tooLarge` | Boolean! | Shows whether the blob too large to be displayed |
@@ -3532,7 +3532,7 @@ Represents the Geo sync and verification state of a snippet repository.
 | `id` | ID! | ID of the entry |
 | `name` | String! | Name of the entry |
 | `path` | String! | Path of the entry |
-| `sha` | String! | Last commit sha for the entry |
+| `sha` | String! | Last commit SHA for the entry |
 | `treeUrl` | String | Tree URL for the sub-module |
 | `type` | EntryType! | Type of tree entry |
 | `webUrl` | String | Web URL for the sub-module |
@@ -3759,7 +3759,7 @@ Represents a directory.
 | `id` | ID! | ID of the entry |
 | `name` | String! | Name of the entry |
 | `path` | String! | Path of the entry |
-| `sha` | String! | Last commit sha for the entry |
+| `sha` | String! | Last commit SHA for the entry |
 | `type` | EntryType! | Type of tree entry |
 | `webPath` | String | Web path for the tree entry (directory) |
 | `webUrl` | String | Web URL for the tree entry (directory) |

ee/app/graphql/types/incident_management/oncall_rotation_type.rb

@@ -41,7 +41,7 @@ module Types
       field :shifts,
             ::Types::IncidentManagement::OncallShiftType.connection_type,
             null: true,
-            description: 'Blocks of time for which a participant is on-call within a given timeframe. Timeframe cannot exceed one month.',
+            description: 'Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.',
             resolver: ::Resolvers::IncidentManagement::OncallShiftsResolver
     end
   end

ee/app/graphql/types/security_report_summary_type.rb

@@ -8,7 +8,7 @@ module Types
 
     ::Enums::Vulnerability.report_types.keys.each do |report_type|
       field report_type, ::Types::SecurityReportSummarySectionType, null: true,
-            description: "Aggregated counts for the #{report_type} scan"
+            description: "Aggregated counts for the `#{report_type}` scan"
     end
   end
 end