diff options
Diffstat (limited to 'doc/api/graphql/reference/index.md')
| -rw-r--r-- | doc/api/graphql/reference/index.md | 338 |
1 files changed, 174 insertions, 164 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 8b55556924d..1190408f864 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -952,6 +952,16 @@ Autogenerated return type of DastProfileDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | +### DastProfileRunPayload + +Autogenerated return type of DastProfileRun. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `pipelineUrl` | String | URL of the pipeline that was created. | + ### DastScannerProfile Represents a DAST scanner profile. @@ -1683,37 +1693,37 @@ Represents an external issue. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time | Timestamp of when the issue was created | -| `externalTracker` | String | Type of external tracker | -| `relativeReference` | String | Relative reference of the issue in the external tracker | -| `status` | String | Status of the issue in the external tracker | -| `title` | String | Title of the issue in the external tracker | -| `updatedAt` | Time | Timestamp of when the issue was updated | -| `webUrl` | String | URL to the issue in the external tracker | +| `createdAt` | Time | Timestamp of when the issue was created. | +| `externalTracker` | String | Type of external tracker. | +| `relativeReference` | String | Relative reference of the issue in the external tracker. | +| `status` | String | Status of the issue in the external tracker. | +| `title` | String | Title of the issue in the external tracker. | +| `updatedAt` | Time | Timestamp of when the issue was updated. | +| `webUrl` | String | URL to the issue in the external tracker. | ### GeoNode | Field | Type | Description | | ----- | ---- | ----------- | -| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node | -| `enabled` | Boolean | Indicates whether this Geo node is enabled | -| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node | -| `id` | ID! | ID of this GeoNode | -| `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it | -| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node | -| `minimumReverificationInterval` | Int | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified | -| `name` | String | The unique identifier for this Geo node | -| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode | -| `primary` | Boolean | Indicates whether this Geo node is the primary | -| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node | -| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces` | -| `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards` | -| `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards | -| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node | -| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage | -| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node | -| `url` | String | The user-facing URL for this Geo node | -| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node | +| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node. | +| `enabled` | Boolean | Indicates whether this Geo node is enabled. | +| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node. | +| `id` | ID! | ID of this GeoNode. | +| `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it. | +| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node. | +| `minimumReverificationInterval` | Int | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. | +| `name` | String | The unique identifier for this Geo node. | +| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode. | +| `primary` | Boolean | Indicates whether this Geo node is the primary. | +| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node. | +| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces`. | +| `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. | +| `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards. | +| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node. | +| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage. | +| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node. | +| `url` | String | The user-facing URL for this Geo node. | +| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node. | ### GitlabSubscriptionActivatePayload @@ -1838,7 +1848,7 @@ Contains statistics about a group. | Field | Type | Description | | ----- | ---- | ----------- | -| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group | +| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. | ### HttpIntegrationCreatePayload @@ -1900,11 +1910,11 @@ Describes an incident management on-call schedule. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String | Description of the on-call schedule | -| `iid` | ID! | Internal ID of the on-call schedule | -| `name` | String! | Name of the on-call schedule | -| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule | -| `timezone` | String! | Time zone of the on-call schedule | +| `description` | String | Description of the on-call schedule. | +| `iid` | ID! | Internal ID of the on-call schedule. | +| `name` | String! | Name of the on-call schedule. | +| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule. | +| `timezone` | String! | Time zone of the on-call schedule. | ### IncidentManagementOncallShift @@ -1920,10 +1930,10 @@ A block of time for which a participant is on-call.. | Field | Type | Description | | ----- | ---- | ----------- | -| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard | -| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade | -| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard | -| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard | +| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard. | +| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade. | +| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. | ### InstanceStatisticsMeasurement @@ -2135,21 +2145,21 @@ Represents an iteration object. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp of iteration creation | -| `description` | String | Description of the iteration | +| `createdAt` | Time! | Timestamp of iteration creation. | +| `description` | String | Description of the iteration. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `dueDate` | Time | Timestamp of the iteration due date | -| `id` | ID! | ID of the iteration | -| `iid` | ID! | Internal ID of the iteration | -| `report` | TimeboxReport | Historically accurate report about the timebox | -| `scopedPath` | String | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts | -| `scopedUrl` | String | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts | -| `startDate` | Time | Timestamp of the iteration start date | -| `state` | IterationState! | State of the iteration | -| `title` | String! | Title of the iteration | -| `updatedAt` | Time! | Timestamp of last iteration update | -| `webPath` | String! | Web path of the iteration | -| `webUrl` | String! | Web URL of the iteration | +| `dueDate` | Time | Timestamp of the iteration due date. | +| `id` | ID! | ID of the iteration. | +| `iid` | ID! | Internal ID of the iteration. | +| `report` | TimeboxReport | Historically accurate report about the timebox. | +| `scopedPath` | String | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| `scopedUrl` | String | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| `startDate` | Time | Timestamp of the iteration start date. | +| `state` | IterationState! | State of the iteration. | +| `title` | String! | Title of the iteration. | +| `updatedAt` | Time! | Timestamp of last iteration update. | +| `webPath` | String! | Web path of the iteration. | +| `webUrl` | String! | Web URL of the iteration. | ### JiraImport @@ -2348,7 +2358,7 @@ Represents the Geo sync and verification state of a Merge Request diff. | `id` | ID! | ID of the MergeRequestDiffRegistry | | `lastSyncFailure` | String | Error message during sync of the MergeRequestDiffRegistry | | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry | -| `mergeRequestDiffId` | ID! | ID of the Merge Request diff | +| `mergeRequestDiffId` | ID! | ID of the Merge Request diff. | | `retryAt` | Time | Timestamp after which the MergeRequestDiffRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry | | `state` | RegistryState | Sync state of the MergeRequestDiffRegistry | @@ -2462,11 +2472,11 @@ Represents a metric image upload. | Field | Type | Description | | ----- | ---- | ----------- | -| `fileName` | String | File name of the metric image | -| `filePath` | String | File path of the metric image | -| `id` | ID! | ID of the metric upload | -| `iid` | ID! | Internal ID of the metric upload | -| `url` | String! | URL of the metric source | +| `fileName` | String | File name of the metric image. | +| `filePath` | String | File path of the metric image. | +| `id` | ID! | ID of the metric upload. | +| `iid` | ID! | Internal ID of the metric upload. | +| `url` | String! | URL of the metric source. | ### MetricsDashboard @@ -2498,7 +2508,7 @@ Represents a milestone. | `groupMilestone` | Boolean! | Indicates if milestone is at group level. | | `id` | ID! | ID of the milestone. | | `projectMilestone` | Boolean! | Indicates if milestone is at project level. | -| `report` | TimeboxReport | Historically accurate report about the timebox | +| `report` | TimeboxReport | Historically accurate report about the timebox. | | `startDate` | Time | Timestamp of the milestone start date. | | `state` | MilestoneStateEnum! | State of the milestone. | | `stats` | MilestoneStats | Milestone statistics. | @@ -2688,7 +2698,7 @@ Represents the Geo sync and verification state of a package file. | `id` | ID! | ID of the PackageFileRegistry | | `lastSyncFailure` | String | Error message during sync of the PackageFileRegistry | | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the PackageFileRegistry | -| `packageFileId` | ID! | ID of the PackageFile | +| `packageFileId` | ID! | ID of the PackageFile. | | `retryAt` | Time | Timestamp after which the PackageFileRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the PackageFileRegistry | | `state` | RegistryState | Sync state of the PackageFileRegistry | @@ -3223,20 +3233,20 @@ Represents a requirement. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User! | Author of the requirement | -| `createdAt` | Time! | Timestamp of when the requirement was created | -| `description` | String | Description of the requirement | +| `author` | User! | Author of the requirement. | +| `createdAt` | Time! | Timestamp of when the requirement was created. | +| `description` | String | Description of the requirement. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `id` | ID! | ID of the requirement | -| `iid` | ID! | Internal ID of the requirement | -| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user | -| `lastTestReportState` | TestReportState | Latest requirement test report state | -| `project` | Project! | Project to which the requirement belongs | -| `state` | RequirementState! | State of the requirement | -| `testReports` | TestReportConnection | Test reports of the requirement | -| `title` | String | Title of the requirement | +| `id` | ID! | ID of the requirement. | +| `iid` | ID! | Internal ID of the requirement. | +| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user. | +| `lastTestReportState` | TestReportState | Latest requirement test report state. | +| `project` | Project! | Project to which the requirement belongs. | +| `state` | RequirementState! | State of the requirement. | +| `testReports` | TestReportConnection | Test reports of the requirement. | +| `title` | String | Title of the requirement. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `updatedAt` | Time! | Timestamp of when the requirement was last updated | +| `updatedAt` | Time! | Timestamp of when the requirement was last updated. | | `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource | ### RequirementPermissions @@ -3257,8 +3267,8 @@ Counts of requirements by their state. | Field | Type | Description | | ----- | ---- | ----------- | -| `archived` | Int | Number of archived requirements | -| `opened` | Int | Number of opened requirements | +| `archived` | Int | Number of archived requirements. | +| `opened` | Int | Number of opened requirements. | ### RevertVulnerabilityToDetectedPayload @@ -3368,8 +3378,8 @@ Represents a resource scanned by a security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `requestMethod` | String | The HTTP request method used to access the URL | -| `url` | String | The URL scanned by the scanner | +| `requestMethod` | String | The HTTP request method used to access the URL. | +| `url` | String | The URL scanned by the scanner. | ### SecurityReportSummary @@ -3391,10 +3401,10 @@ Represents a section of a summary of a security report. | Field | Type | Description | | ----- | ---- | ----------- | -| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources | -| `scannedResourcesCount` | Int | Total number of scanned resources | -| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format | -| `vulnerabilitiesCount` | Int | Total number of vulnerabilities | +| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources. | +| `scannedResourcesCount` | Int | Total number of scanned resources. | +| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format. | +| `vulnerabilitiesCount` | Int | Total number of vulnerabilities. | ### SecurityScanners @@ -3605,7 +3615,7 @@ Represents the Geo sync and verification state of a snippet repository. | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry | | `retryAt` | Time | Timestamp after which the SnippetRepositoryRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry | -| `snippetRepositoryId` | ID! | ID of the Snippet Repository | +| `snippetRepositoryId` | ID! | ID of the Snippet Repository. | | `state` | RegistryState | Sync state of the SnippetRepositoryRegistry | ### StatusAction @@ -3704,7 +3714,7 @@ Represents the Geo sync and verification state of a terraform state version. | `retryAt` | Time | Timestamp after which the TerraformStateVersionRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry | | `state` | RegistryState | Sync state of the TerraformStateVersionRegistry | -| `terraformStateVersionId` | ID! | ID of the terraform state version | +| `terraformStateVersionId` | ID! | ID of the terraform state version. | ### TestReport @@ -3712,10 +3722,10 @@ Represents a requirement test report. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User | Author of the test report | -| `createdAt` | Time! | Timestamp of when the test report was created | -| `id` | ID! | ID of the test report | -| `state` | TestReportState! | State of the test report | +| `author` | User | Author of the test report. | +| `createdAt` | Time! | Timestamp of when the test report was created. | +| `id` | ID! | ID of the test report. | +| `state` | TestReportState! | State of the test report. | ### TimeReportStats @@ -3723,9 +3733,9 @@ Represents the time report stats for timeboxes. | Field | Type | Description | | ----- | ---- | ----------- | -| `complete` | TimeboxMetrics | Completed issues metrics | -| `incomplete` | TimeboxMetrics | Incomplete issues metrics | -| `total` | TimeboxMetrics | Total issues metrics | +| `complete` | TimeboxMetrics | Completed issues metrics. | +| `incomplete` | TimeboxMetrics | Incomplete issues metrics. | +| `total` | TimeboxMetrics | Total issues metrics. | ### TimeboxMetrics @@ -3733,8 +3743,8 @@ Represents measured stats metrics for timeboxes. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | The count metric | -| `weight` | Int! | The weight metric | +| `count` | Int! | The count metric. | +| `weight` | Int! | The weight metric. | ### TimeboxReport @@ -3742,18 +3752,18 @@ Represents a historically accurate report about the timebox. | Field | Type | Description | | ----- | ---- | ----------- | -| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts | -| `stats` | TimeReportStats | Represents the time report stats for the timebox | +| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts. | +| `stats` | TimeReportStats | Represents the time report stats for the timebox. | ### Timelog | Field | Type | Description | | ----- | ---- | ----------- | -| `issue` | Issue | The issue that logged time was added to | -| `note` | Note | The note where the quick action to add the logged time was executed | -| `spentAt` | Time | Timestamp of when the time tracked was spent at | -| `timeSpent` | Int! | The time spent displayed in seconds | -| `user` | User! | The user that logged the time | +| `issue` | Issue | The issue that logged time was added to. | +| `note` | Note | The note where the quick action to add the logged time was executed. | +| `spentAt` | Time | Timestamp of when the time tracked was spent at. | +| `timeSpent` | Int! | The time spent displayed in seconds. | +| `user` | User! | The user that logged the time. | ### Todo @@ -4062,12 +4072,12 @@ Represents the count of vulnerabilities by severity on a particular day. This da | Field | Type | Description | | ----- | ---- | ----------- | | `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity | -| `date` | ISO8601Date! | Date for the count | +| `date` | ISO8601Date! | Date for the count. | | `high` | Int! | Total number of vulnerabilities on a particular day with high severity | | `info` | Int! | Total number of vulnerabilities on a particular day with info severity | | `low` | Int! | Total number of vulnerabilities on a particular day with low severity | | `medium` | Int! | Total number of vulnerabilities on a particular day with medium severity | -| `total` | Int! | Total number of vulnerabilities on a particular day | +| `total` | Int! | Total number of vulnerabilities on a particular day. | | `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity | ### VulnerabilitiesCountByDayAndSeverity @@ -4076,9 +4086,9 @@ Represents the number of vulnerabilities for a particular severity on a particul | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int | Number of vulnerabilities | -| `day` | ISO8601Date | Date for the count | -| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities | +| `count` | Int | Number of vulnerabilities. | +| `day` | ISO8601Date | Date for the count. | +| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities. | ### Vulnerability @@ -4086,35 +4096,35 @@ Represents a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed | +| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed. | | `confirmedBy` | User | The user that confirmed the vulnerability. | -| `description` | String | Description of the vulnerability | -| `details` | VulnerabilityDetail! => Array | Details of the vulnerability | -| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected | +| `description` | String | Description of the vulnerability. | +| `details` | VulnerabilityDetail! => Array | Details of the vulnerability. | +| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected. | | `discussions` | DiscussionConnection! | All discussions on this noteable. | -| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed | +| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed. | | `dismissedBy` | User | The user that dismissed the vulnerability. | -| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability | +| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability. | | `hasSolutions` | Boolean | Indicates whether there is a solution available for this vulnerability. | -| `id` | ID! | GraphQL ID of the vulnerability | +| `id` | ID! | GraphQL ID of the vulnerability. | | `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. | -| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability | -| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability | +| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability. | +| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | | `mergeRequest` | MergeRequest | Merge request that fixes the vulnerability. | | `notes` | NoteConnection! | All notes on this noteable. | | `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. | -| `project` | Project | The project on which the vulnerability was found | +| `project` | Project | The project on which the vulnerability was found. | | `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) | -| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved | +| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved. | | `resolvedBy` | User | The user that resolved the vulnerability. | -| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not | +| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not. | | `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. | | `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) | | `state` | VulnerabilityState | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED) | -| `title` | String | Title of the vulnerability | -| `userNotesCount` | Int! | Number of user notes attached to the vulnerability | +| `title` | String | Title of the vulnerability. | +| `userNotesCount` | Int! | Number of user notes attached to the vulnerability. | | `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource | -| `vulnerabilityPath` | String | URL to the vulnerability's details page | +| `vulnerabilityPath` | String | URL to the vulnerability's details page. | ### VulnerabilityConfirmPayload @@ -4291,9 +4301,9 @@ Represents an external issue link of a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalIssue` | ExternalIssue | The external issue attached to the issue link | -| `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link | -| `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link | +| `externalIssue` | ExternalIssue | The external issue attached to the issue link. | +| `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link. | +| `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link. | ### VulnerabilityExternalIssueLinkCreatePayload @@ -4320,10 +4330,10 @@ Represents a vulnerability identifier. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalId` | String | External ID of the vulnerability identifier | -| `externalType` | String | External type of the vulnerability identifier | -| `name` | String | Name of the vulnerability identifier | -| `url` | String | URL of the vulnerability identifier | +| `externalId` | String | External ID of the vulnerability identifier. | +| `externalType` | String | External type of the vulnerability identifier. | +| `name` | String | Name of the vulnerability identifier. | +| `url` | String | URL of the vulnerability identifier. | ### VulnerabilityIssueLink @@ -4331,9 +4341,9 @@ Represents an issue link of a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | ID! | GraphQL ID of the vulnerability | -| `issue` | Issue! | The issue attached to issue link | -| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link | +| `id` | ID! | GraphQL ID of the vulnerability. | +| `issue` | Issue! | The issue attached to issue link. | +| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link. | ### VulnerabilityLocationContainerScanning @@ -4341,9 +4351,9 @@ Represents the location of a vulnerability found by a container security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `dependency` | VulnerableDependency | Dependency containing the vulnerability | -| `image` | String | Name of the vulnerable container image | -| `operatingSystem` | String | Operating system that runs on the vulnerable container image | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability. | +| `image` | String | Name of the vulnerable container image. | +| `operatingSystem` | String | Operating system that runs on the vulnerable container image. | ### VulnerabilityLocationCoverageFuzzing @@ -4351,12 +4361,12 @@ Represents the location of a vulnerability found by a Coverage Fuzzing scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `blobPath` | String | Blob path to the vulnerable file | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityLocationDast @@ -4364,10 +4374,10 @@ Represents the location of a vulnerability found by a DAST scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `hostname` | String | Domain name of the vulnerable request | -| `param` | String | Query parameter for the URL on which the vulnerability occurred | -| `path` | String | URL path and query string of the vulnerable request | -| `requestMethod` | String | HTTP method of the vulnerable request | +| `hostname` | String | Domain name of the vulnerable request. | +| `param` | String | Query parameter for the URL on which the vulnerability occurred. | +| `path` | String | URL path and query string of the vulnerable request. | +| `requestMethod` | String | HTTP method of the vulnerable request. | ### VulnerabilityLocationDependencyScanning @@ -4375,9 +4385,9 @@ Represents the location of a vulnerability found by a dependency security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `blobPath` | String | Blob path to the vulnerable file | -| `dependency` | VulnerableDependency | Dependency containing the vulnerability | -| `file` | String | Path to the vulnerable file | +| `blobPath` | String | Blob path to the vulnerable file. | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability. | +| `file` | String | Path to the vulnerable file. | ### VulnerabilityLocationSast @@ -4385,12 +4395,12 @@ Represents the location of a vulnerability found by a SAST scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `blobPath` | String | Blob path to the vulnerable file | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityLocationSecretDetection @@ -4398,12 +4408,12 @@ Represents the location of a vulnerability found by a secret detection scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `blobPath` | String | Blob path to the vulnerable file | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityPermissions @@ -4447,10 +4457,10 @@ Represents a vulnerability scanner. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalId` | String | External ID of the vulnerability scanner | -| `name` | String | Name of the vulnerability scanner | -| `reportType` | VulnerabilityReportType | Type of the vulnerability report | -| `vendor` | String | Vendor of the vulnerability scanner | +| `externalId` | String | External ID of the vulnerability scanner. | +| `name` | String | Name of the vulnerability scanner. | +| `reportType` | VulnerabilityReportType | Type of the vulnerability report. | +| `vendor` | String | Vendor of the vulnerability scanner. | ### VulnerabilitySeveritiesCount @@ -4471,8 +4481,8 @@ Represents a vulnerable dependency. Used in vulnerability location data. | Field | Type | Description | | ----- | ---- | ----------- | -| `package` | VulnerablePackage | The package associated with the vulnerable dependency | -| `version` | String | The version of the vulnerable dependency | +| `package` | VulnerablePackage | The package associated with the vulnerable dependency. | +| `version` | String | The version of the vulnerable dependency. | ### VulnerablePackage @@ -4480,7 +4490,7 @@ Represents a vulnerable package. Used in vulnerability dependency data. | Field | Type | Description | | ----- | ---- | ----------- | -| `name` | String | The name of the vulnerable package | +| `name` | String | The name of the vulnerable package. | ### VulnerableProjectsByGrade @@ -4488,9 +4498,9 @@ Represents vulnerability letter grades with associated projects. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Number of projects within this grade | -| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present | -| `projects` | ProjectConnection! | Projects within this grade | +| `count` | Int! | Number of projects within this grade. | +| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present. | +| `projects` | ProjectConnection! | Projects within this grade. | ## Enumeration types |