diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md | 5 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 379 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 481 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 338 | ||||
| -rw-r--r-- | doc/development/elasticsearch.md | 2 | ||||
| -rw-r--r-- | doc/integration/elasticsearch.md | 38 | ||||
| -rw-r--r-- | doc/user/admin_area/settings/account_and_limit_settings.md | 22 |
7 files changed, 721 insertions, 544 deletions
diff --git a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md index c654e029a9c..9ac0dce8136 100644 --- a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md +++ b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md @@ -10,8 +10,9 @@ type: reference This is the GitLab Support Team's collection of information regarding the GitLab Rails console, for use while troubleshooting. It is listed here for transparency, and it may be useful for users with experience with these tools. If you are currently -having an issue with GitLab, it is highly recommended that you check your -[support options](https://about.gitlab.com/support/) first, before attempting to use +having an issue with GitLab, it is highly recommended that you first check +our guide on [navigating our Rails console](navigating_gitlab_via_rails_console.md), +and your [support options](https://about.gitlab.com/support/), before attempting to use this information. WARNING: diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index e571e13b168..c88a6d0bff5 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -5902,6 +5902,46 @@ Identifier of Dast::Profile. """ scalar DastProfileID +""" +Autogenerated input type of DastProfileRun +""" +input DastProfileRunInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Full path for the project the scanner profile belongs to. + """ + fullPath: ID! + + """ + ID of the profile to be used for the scan. + """ + id: DastProfileID! +} + +""" +Autogenerated return type of DastProfileRun +""" +type DastProfileRunPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + URL of the pipeline that was created. + """ + pipelineUrl: String +} + enum DastScanTypeEnum { """ Active DAST scan. This scan will make active attacks against the target site. @@ -10136,22 +10176,22 @@ A node of an epic tree. """ input EpicTreeNodeFieldsInputType { """ - The ID of the epic_issue or issue that the actual epic or issue is switched with + The ID of the epic_issue or issue that the actual epic or issue is switched with. """ adjacentReferenceId: EpicTreeSortingID """ - The ID of the epic_issue or epic that is being moved + The ID of the epic_issue or epic that is being moved. """ id: EpicTreeSortingID! """ - ID of the new parent epic + ID of the new parent epic. """ newParentId: EpicID """ - The type of the switch, after or before allowed + The type of the switch, after or before allowed. """ relativePosition: MoveType } @@ -10271,69 +10311,69 @@ Represents an external issue """ type ExternalIssue { """ - Timestamp of when the issue was created + Timestamp of when the issue was created. """ createdAt: Time """ - Type of external tracker + Type of external tracker. """ externalTracker: String """ - Relative reference of the issue in the external tracker + Relative reference of the issue in the external tracker. """ relativeReference: String """ - Status of the issue in the external tracker + Status of the issue in the external tracker. """ status: String """ - Title of the issue in the external tracker + Title of the issue in the external tracker. """ title: String """ - Timestamp of when the issue was updated + Timestamp of when the issue was updated. """ updatedAt: Time """ - URL to the issue in the external tracker + URL to the issue in the external tracker. """ webUrl: String } type GeoNode { """ - The maximum concurrency of container repository sync for this secondary node + The maximum concurrency of container repository sync for this secondary node. """ containerRepositoriesMaxCapacity: Int """ - Indicates whether this Geo node is enabled + Indicates whether this Geo node is enabled. """ enabled: Boolean """ - The maximum concurrency of LFS/attachment backfill for this secondary node + The maximum concurrency of LFS/attachment backfill for this secondary node. """ filesMaxCapacity: Int """ - ID of this GeoNode + ID of this GeoNode. """ id: ID! """ - The URL defined on the primary node that secondary nodes should use to contact it + The URL defined on the primary node that secondary nodes should use to contact it. """ internalUrl: String """ - Find merge request diff registries on this Geo node + Find merge request diff registries on this Geo node. """ mergeRequestDiffRegistries( """ @@ -10363,17 +10403,17 @@ type GeoNode { ): MergeRequestDiffRegistryConnection """ - The interval (in days) in which the repository verification is valid. Once expired, it will be reverified + The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. """ minimumReverificationInterval: Int """ - The unique identifier for this Geo node + The unique identifier for this Geo node. """ name: String """ - Package file registries of the GeoNode + Package file registries of the GeoNode. """ packageFileRegistries( """ @@ -10403,17 +10443,17 @@ type GeoNode { ): PackageFileRegistryConnection """ - Indicates whether this Geo node is the primary + Indicates whether this Geo node is the primary. """ primary: Boolean """ - The maximum concurrency of repository backfill for this secondary node + The maximum concurrency of repository backfill for this secondary node. """ reposMaxCapacity: Int """ - The namespaces that should be synced, if `selective_sync_type` == `namespaces` + The namespaces that should be synced, if `selective_sync_type` == `namespaces`. """ selectiveSyncNamespaces( """ @@ -10438,17 +10478,17 @@ type GeoNode { ): NamespaceConnection """ - The repository storages whose projects should be synced, if `selective_sync_type` == `shards` + The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. """ selectiveSyncShards: [String!] """ - Indicates if syncing is limited to only specific groups, or shards + Indicates if syncing is limited to only specific groups, or shards. """ selectiveSyncType: String """ - Find snippet repository registries on this Geo node + Find snippet repository registries on this Geo node. """ snippetRepositoryRegistries( """ @@ -10478,12 +10518,12 @@ type GeoNode { ): SnippetRepositoryRegistryConnection """ - Indicates if this secondary node will replicate blobs in Object Storage + Indicates if this secondary node will replicate blobs in Object Storage. """ syncObjectStorage: Boolean """ - Find terraform state version registries on this Geo node + Find terraform state version registries on this Geo node. """ terraformStateVersionRegistries( """ @@ -10513,12 +10553,12 @@ type GeoNode { ): TerraformStateVersionRegistryConnection """ - The user-facing URL for this Geo node + The user-facing URL for this Geo node. """ url: String """ - The maximum concurrency of repository verification for this secondary node + The maximum concurrency of repository verification for this secondary node. """ verificationMaxCapacity: Int } @@ -12005,7 +12045,7 @@ Contains statistics about a group """ type GroupStats { """ - Statistics related to releases within the group + Statistics related to releases within the group. """ releaseStats: GroupReleaseStats } @@ -12344,22 +12384,22 @@ Describes an incident management on-call schedule """ type IncidentManagementOncallSchedule { """ - Description of the on-call schedule + Description of the on-call schedule. """ description: String """ - Internal ID of the on-call schedule + Internal ID of the on-call schedule. """ iid: ID! """ - Name of the on-call schedule + Name of the on-call schedule. """ name: String! """ - On-call rotations for the on-call schedule + On-call rotations for the on-call schedule. """ rotations( """ @@ -12384,7 +12424,7 @@ type IncidentManagementOncallSchedule { ): IncidentManagementOncallRotationConnection! """ - Time zone of the on-call schedule + Time zone of the on-call schedule. """ timezone: String! } @@ -12481,7 +12521,7 @@ type IncidentManagementOncallShiftEdge { type InstanceSecurityDashboard { """ - Projects selected in Instance Security Dashboard + Projects selected in Instance Security Dashboard. """ projects( """ @@ -12506,12 +12546,12 @@ type InstanceSecurityDashboard { ): ProjectConnection! """ - Represents vulnerable project counts for each grade + Represents vulnerable project counts for each grade. """ vulnerabilityGrades: [VulnerableProjectsByGrade!]! """ - Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard + Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. """ vulnerabilityScanners( """ @@ -12536,7 +12576,7 @@ type InstanceSecurityDashboard { ): VulnerabilityScannerConnection """ - Counts for each vulnerability severity from projects selected in Instance Security Dashboard + Counts for each vulnerability severity from projects selected in Instance Security Dashboard. """ vulnerabilitySeveritiesCount( """ @@ -13883,12 +13923,12 @@ Represents an iteration object """ type Iteration implements TimeboxReportInterface { """ - Timestamp of iteration creation + Timestamp of iteration creation. """ createdAt: Time! """ - Description of the iteration + Description of the iteration. """ description: String @@ -13898,62 +13938,62 @@ type Iteration implements TimeboxReportInterface { descriptionHtml: String """ - Timestamp of the iteration due date + Timestamp of the iteration due date. """ dueDate: Time """ - ID of the iteration + ID of the iteration. """ id: ID! """ - Internal ID of the iteration + Internal ID of the iteration. """ iid: ID! """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport """ - Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts + Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. """ scopedPath: String """ - Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts + Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. """ scopedUrl: String """ - Timestamp of the iteration start date + Timestamp of the iteration start date. """ startDate: Time """ - State of the iteration + State of the iteration. """ state: IterationState! """ - Title of the iteration + Title of the iteration. """ title: String! """ - Timestamp of last iteration update + Timestamp of last iteration update. """ updatedAt: Time! """ - Web path of the iteration + Web path of the iteration. """ webPath: String! """ - Web URL of the iteration + Web URL of the iteration. """ webUrl: String! } @@ -15437,7 +15477,7 @@ type MergeRequestDiffRegistry { lastSyncedAt: Time """ - ID of the Merge Request diff + ID of the Merge Request diff. """ mergeRequestDiffId: ID! @@ -16059,27 +16099,27 @@ Represents a metric image upload """ type MetricImage { """ - File name of the metric image + File name of the metric image. """ fileName: String """ - File path of the metric image + File path of the metric image. """ filePath: String """ - ID of the metric upload + ID of the metric upload. """ id: ID! """ - Internal ID of the metric upload + Internal ID of the metric upload. """ iid: ID! """ - URL of the metric source + URL of the metric source. """ url: String! } @@ -16233,7 +16273,7 @@ type Milestone implements TimeboxReportInterface { projectMilestone: Boolean! """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport @@ -16399,6 +16439,7 @@ type Mutation { dastOnDemandScanCreate(input: DastOnDemandScanCreateInput!): DastOnDemandScanCreatePayload dastProfileCreate(input: DastProfileCreateInput!): DastProfileCreatePayload dastProfileDelete(input: DastProfileDeleteInput!): DastProfileDeletePayload + dastProfileRun(input: DastProfileRunInput!): DastProfileRunPayload dastScannerProfileCreate(input: DastScannerProfileCreateInput!): DastScannerProfileCreatePayload dastScannerProfileDelete(input: DastScannerProfileDeleteInput!): DastScannerProfileDeletePayload dastScannerProfileUpdate(input: DastScannerProfileUpdateInput!): DastScannerProfileUpdatePayload @@ -17680,7 +17721,7 @@ type PackageFileRegistry { lastSyncedAt: Time """ - ID of the PackageFile + ID of the PackageFile. """ packageFileId: ID! @@ -22449,17 +22490,17 @@ Represents a requirement """ type Requirement { """ - Author of the requirement + Author of the requirement. """ author: User! """ - Timestamp of when the requirement was created + Timestamp of when the requirement was created. """ createdAt: Time! """ - Description of the requirement + Description of the requirement. """ description: String @@ -22469,37 +22510,37 @@ type Requirement { descriptionHtml: String """ - ID of the requirement + ID of the requirement. """ id: ID! """ - Internal ID of the requirement + Internal ID of the requirement. """ iid: ID! """ - Indicates if latest test report was created by user + Indicates if latest test report was created by user. """ lastTestReportManuallyCreated: Boolean """ - Latest requirement test report state + Latest requirement test report state. """ lastTestReportState: TestReportState """ - Project to which the requirement belongs + Project to which the requirement belongs. """ project: Project! """ - State of the requirement + State of the requirement. """ state: RequirementState! """ - Test reports of the requirement + Test reports of the requirement. """ testReports( """ @@ -22529,7 +22570,7 @@ type Requirement { ): TestReportConnection """ - Title of the requirement + Title of the requirement. """ title: String @@ -22539,7 +22580,7 @@ type Requirement { titleHtml: String """ - Timestamp of when the requirement was last updated + Timestamp of when the requirement was last updated. """ updatedAt: Time! @@ -22627,12 +22668,12 @@ Counts of requirements by their state """ type RequirementStatesCount { """ - Number of archived requirements + Number of archived requirements. """ archived: Int """ - Number of opened requirements + Number of opened requirements. """ opened: Int } @@ -23311,12 +23352,12 @@ Represents a resource scanned by a security scan """ type ScannedResource { """ - The HTTP request method used to access the URL + The HTTP request method used to access the URL. """ requestMethod: String """ - The URL scanned by the scanner + The URL scanned by the scanner. """ url: String } @@ -23401,7 +23442,7 @@ Represents a section of a summary of a security report """ type SecurityReportSummarySection { """ - A list of the first 20 scanned resources + A list of the first 20 scanned resources. """ scannedResources( """ @@ -23426,17 +23467,17 @@ type SecurityReportSummarySection { ): ScannedResourceConnection """ - Total number of scanned resources + Total number of scanned resources. """ scannedResourcesCount: Int """ - Path to download all the scanned resources in CSV format + Path to download all the scanned resources in CSV format. """ scannedResourcesCsvPath: String """ - Total number of vulnerabilities + Total number of vulnerabilities. """ vulnerabilitiesCount: Int } @@ -24639,7 +24680,7 @@ type SnippetRepositoryRegistry { retryCount: Int """ - ID of the Snippet Repository + ID of the Snippet Repository. """ snippetRepositoryId: ID! @@ -25097,7 +25138,7 @@ type TerraformStateVersionRegistry { state: RegistryState """ - ID of the terraform state version + ID of the terraform state version. """ terraformStateVersionId: ID! } @@ -25142,22 +25183,22 @@ Represents a requirement test report """ type TestReport { """ - Author of the test report + Author of the test report. """ author: User """ - Timestamp of when the test report was created + Timestamp of when the test report was created. """ createdAt: Time! """ - ID of the test report + ID of the test report. """ id: ID! """ - State of the test report + State of the test report. """ state: TestReportState! } @@ -25215,17 +25256,17 @@ Represents the time report stats for timeboxes """ type TimeReportStats { """ - Completed issues metrics + Completed issues metrics. """ complete: TimeboxMetrics """ - Incomplete issues metrics + Incomplete issues metrics. """ incomplete: TimeboxMetrics """ - Total issues metrics + Total issues metrics. """ total: TimeboxMetrics } @@ -25235,12 +25276,12 @@ Represents measured stats metrics for timeboxes """ type TimeboxMetrics { """ - The count metric + The count metric. """ count: Int! """ - The weight metric + The weight metric. """ weight: Int! } @@ -25250,19 +25291,19 @@ Represents a historically accurate report about the timebox """ type TimeboxReport { """ - Daily scope and completed totals for burnup charts + Daily scope and completed totals for burnup charts. """ burnupTimeSeries: [BurnupChartDailyTotals!] """ - Represents the time report stats for the timebox + Represents the time report stats for the timebox. """ stats: TimeReportStats } interface TimeboxReportInterface { """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport } @@ -25284,27 +25325,27 @@ input Timeframe { type Timelog { """ - The issue that logged time was added to + The issue that logged time was added to. """ issue: Issue """ - The note where the quick action to add the logged time was executed + The note where the quick action to add the logged time was executed. """ note: Note """ - Timestamp of when the time tracked was spent at + Timestamp of when the time tracked was spent at. """ spentAt: Time """ - The time spent displayed in seconds + The time spent displayed in seconds. """ timeSpent: Int! """ - The user that logged the time + The user that logged the time. """ user: User! } @@ -27449,7 +27490,7 @@ type VulnerabilitiesCountByDay { critical: Int! """ - Date for the count + Date for the count. """ date: ISO8601Date! @@ -27474,7 +27515,7 @@ type VulnerabilitiesCountByDay { medium: Int! """ - Total number of vulnerabilities on a particular day + Total number of vulnerabilities on a particular day. """ total: Int! @@ -27489,17 +27530,17 @@ Represents the number of vulnerabilities for a particular severity on a particul """ type VulnerabilitiesCountByDayAndSeverity { """ - Number of vulnerabilities + Number of vulnerabilities. """ count: Int """ - Date for the count + Date for the count. """ day: ISO8601Date """ - Severity of the counted vulnerabilities + Severity of the counted vulnerabilities. """ severity: VulnerabilitySeverity } @@ -27584,7 +27625,7 @@ Represents a vulnerability """ type Vulnerability implements Noteable { """ - Timestamp of when the vulnerability state was changed to confirmed + Timestamp of when the vulnerability state was changed to confirmed. """ confirmedAt: Time @@ -27594,17 +27635,17 @@ type Vulnerability implements Noteable { confirmedBy: User """ - Description of the vulnerability + Description of the vulnerability. """ description: String """ - Details of the vulnerability + Details of the vulnerability. """ details: [VulnerabilityDetail!]! """ - Timestamp of when the vulnerability was first detected + Timestamp of when the vulnerability was first detected. """ detectedAt: Time! @@ -27634,7 +27675,7 @@ type Vulnerability implements Noteable { ): DiscussionConnection! """ - Timestamp of when the vulnerability state was changed to dismissed + Timestamp of when the vulnerability state was changed to dismissed. """ dismissedAt: Time @@ -27644,7 +27685,7 @@ type Vulnerability implements Noteable { dismissedBy: User """ - List of external issue links related to the vulnerability + List of external issue links related to the vulnerability. """ externalIssueLinks( """ @@ -27674,7 +27715,7 @@ type Vulnerability implements Noteable { hasSolutions: Boolean """ - GraphQL ID of the vulnerability + GraphQL ID of the vulnerability. """ id: ID! @@ -27684,7 +27725,7 @@ type Vulnerability implements Noteable { identifiers: [VulnerabilityIdentifier!]! """ - List of issue links related to the vulnerability + List of issue links related to the vulnerability. """ issueLinks( """ @@ -27714,7 +27755,7 @@ type Vulnerability implements Noteable { ): VulnerabilityIssueLinkConnection! """ - Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability + Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. """ location: VulnerabilityLocation @@ -27754,7 +27795,7 @@ type Vulnerability implements Noteable { primaryIdentifier: VulnerabilityIdentifier """ - The project on which the vulnerability was found + The project on which the vulnerability was found. """ project: Project @@ -27766,7 +27807,7 @@ type Vulnerability implements Noteable { reportType: VulnerabilityReportType """ - Timestamp of when the vulnerability state was changed to resolved + Timestamp of when the vulnerability state was changed to resolved. """ resolvedAt: Time @@ -27776,7 +27817,7 @@ type Vulnerability implements Noteable { resolvedBy: User """ - Indicates whether the vulnerability is fixed on the default branch or not + Indicates whether the vulnerability is fixed on the default branch or not. """ resolvedOnDefaultBranch: Boolean! @@ -27796,12 +27837,12 @@ type Vulnerability implements Noteable { state: VulnerabilityState """ - Title of the vulnerability + Title of the vulnerability. """ title: String """ - Number of user notes attached to the vulnerability + Number of user notes attached to the vulnerability. """ userNotesCount: Int! @@ -27811,7 +27852,7 @@ type Vulnerability implements Noteable { userPermissions: VulnerabilityPermissions! """ - URL to the vulnerability's details page + URL to the vulnerability's details page. """ vulnerabilityPath: String } @@ -28326,17 +28367,17 @@ Represents an external issue link of a vulnerability """ type VulnerabilityExternalIssueLink { """ - The external issue attached to the issue link + The external issue attached to the issue link. """ externalIssue: ExternalIssue """ - GraphQL ID of the external issue link + GraphQL ID of the external issue link. """ id: VulnerabilitiesExternalIssueLinkID! """ - Type of the external issue link + Type of the external issue link. """ linkType: VulnerabilityExternalIssueLinkType! } @@ -28492,22 +28533,22 @@ Represents a vulnerability identifier """ type VulnerabilityIdentifier { """ - External ID of the vulnerability identifier + External ID of the vulnerability identifier. """ externalId: String """ - External type of the vulnerability identifier + External type of the vulnerability identifier. """ externalType: String """ - Name of the vulnerability identifier + Name of the vulnerability identifier. """ name: String """ - URL of the vulnerability identifier + URL of the vulnerability identifier. """ url: String } @@ -28517,17 +28558,17 @@ Represents an issue link of a vulnerability """ type VulnerabilityIssueLink { """ - GraphQL ID of the vulnerability + GraphQL ID of the vulnerability. """ id: ID! """ - The issue attached to issue link + The issue attached to issue link. """ issue: Issue! """ - Type of the issue link + Type of the issue link. """ linkType: VulnerabilityIssueLinkType! } @@ -28585,17 +28626,17 @@ Represents the location of a vulnerability found by a container security scan """ type VulnerabilityLocationContainerScanning { """ - Dependency containing the vulnerability + Dependency containing the vulnerability. """ dependency: VulnerableDependency """ - Name of the vulnerable container image + Name of the vulnerable container image. """ image: String """ - Operating system that runs on the vulnerable container image + Operating system that runs on the vulnerable container image. """ operatingSystem: String } @@ -28605,32 +28646,32 @@ Represents the location of a vulnerability found by a Coverage Fuzzing scan """ type VulnerabilityLocationCoverageFuzzing { """ - Blob path to the vulnerable file + Blob path to the vulnerable file. """ blobPath: String """ - Number of the last relevant line in the vulnerable file + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -28640,22 +28681,22 @@ Represents the location of a vulnerability found by a DAST scan """ type VulnerabilityLocationDast { """ - Domain name of the vulnerable request + Domain name of the vulnerable request. """ hostname: String """ - Query parameter for the URL on which the vulnerability occurred + Query parameter for the URL on which the vulnerability occurred. """ param: String """ - URL path and query string of the vulnerable request + URL path and query string of the vulnerable request. """ path: String """ - HTTP method of the vulnerable request + HTTP method of the vulnerable request. """ requestMethod: String } @@ -28665,17 +28706,17 @@ Represents the location of a vulnerability found by a dependency security scan """ type VulnerabilityLocationDependencyScanning { """ - Blob path to the vulnerable file + Blob path to the vulnerable file. """ blobPath: String """ - Dependency containing the vulnerability + Dependency containing the vulnerability. """ dependency: VulnerableDependency """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String } @@ -28685,32 +28726,32 @@ Represents the location of a vulnerability found by a SAST scan """ type VulnerabilityLocationSast { """ - Blob path to the vulnerable file + Blob path to the vulnerable file. """ blobPath: String """ - Number of the last relevant line in the vulnerable file + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -28720,32 +28761,32 @@ Represents the location of a vulnerability found by a secret detection scan """ type VulnerabilityLocationSecretDetection { """ - Blob path to the vulnerable file + Blob path to the vulnerable file. """ blobPath: String """ - Number of the last relevant line in the vulnerable file + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -28888,22 +28929,22 @@ Represents a vulnerability scanner """ type VulnerabilityScanner { """ - External ID of the vulnerability scanner + External ID of the vulnerability scanner. """ externalId: String """ - Name of the vulnerability scanner + Name of the vulnerability scanner. """ name: String """ - Type of the vulnerability report + Type of the vulnerability report. """ reportType: VulnerabilityReportType """ - Vendor of the vulnerability scanner + Vendor of the vulnerability scanner. """ vendor: String } @@ -29060,12 +29101,12 @@ Represents a vulnerable dependency. Used in vulnerability location data """ type VulnerableDependency { """ - The package associated with the vulnerable dependency + The package associated with the vulnerable dependency. """ package: VulnerablePackage """ - The version of the vulnerable dependency + The version of the vulnerable dependency. """ version: String } @@ -29075,7 +29116,7 @@ Represents a vulnerable package. Used in vulnerability dependency data """ type VulnerablePackage { """ - The name of the vulnerable package + The name of the vulnerable package. """ name: String } @@ -29085,17 +29126,17 @@ Represents vulnerability letter grades with associated projects """ type VulnerableProjectsByGrade { """ - Number of projects within this grade + Number of projects within this grade. """ count: Int! """ - Grade based on the highest severity vulnerability present + Grade based on the highest severity vulnerability present. """ grade: VulnerabilityGrade! """ - Projects within this grade + Projects within this grade. """ projects( """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 1f5a471a6e5..d3a6ccc4198 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -16060,6 +16060,122 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "DastProfileRunInput", + "description": "Autogenerated input type of DastProfileRun", + "fields": null, + "inputFields": [ + { + "name": "fullPath", + "description": "Full path for the project the scanner profile belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "ID of the profile to be used for the scan.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastProfileID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DastProfileRunPayload", + "description": "Autogenerated return type of DastProfileRun", + "fields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pipelineUrl", + "description": "URL of the pipeline that was created.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "ENUM", "name": "DastScanTypeEnum", "description": null, @@ -27978,7 +28094,7 @@ "inputFields": [ { "name": "id", - "description": "The ID of the epic_issue or epic that is being moved", + "description": "The ID of the epic_issue or epic that is being moved.", "type": { "kind": "NON_NULL", "name": null, @@ -27992,7 +28108,7 @@ }, { "name": "adjacentReferenceId", - "description": "The ID of the epic_issue or issue that the actual epic or issue is switched with", + "description": "The ID of the epic_issue or issue that the actual epic or issue is switched with.", "type": { "kind": "SCALAR", "name": "EpicTreeSortingID", @@ -28002,7 +28118,7 @@ }, { "name": "relativePosition", - "description": "The type of the switch, after or before allowed", + "description": "The type of the switch, after or before allowed.", "type": { "kind": "ENUM", "name": "MoveType", @@ -28012,7 +28128,7 @@ }, { "name": "newParentId", - "description": "ID of the new parent epic", + "description": "ID of the new parent epic.", "type": { "kind": "SCALAR", "name": "EpicID", @@ -28321,7 +28437,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of when the issue was created", + "description": "Timestamp of when the issue was created.", "args": [ ], @@ -28335,7 +28451,7 @@ }, { "name": "externalTracker", - "description": "Type of external tracker", + "description": "Type of external tracker.", "args": [ ], @@ -28349,7 +28465,7 @@ }, { "name": "relativeReference", - "description": "Relative reference of the issue in the external tracker", + "description": "Relative reference of the issue in the external tracker.", "args": [ ], @@ -28363,7 +28479,7 @@ }, { "name": "status", - "description": "Status of the issue in the external tracker", + "description": "Status of the issue in the external tracker.", "args": [ ], @@ -28377,7 +28493,7 @@ }, { "name": "title", - "description": "Title of the issue in the external tracker", + "description": "Title of the issue in the external tracker.", "args": [ ], @@ -28391,7 +28507,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the issue was updated", + "description": "Timestamp of when the issue was updated.", "args": [ ], @@ -28405,7 +28521,7 @@ }, { "name": "webUrl", - "description": "URL to the issue in the external tracker", + "description": "URL to the issue in the external tracker.", "args": [ ], @@ -28442,7 +28558,7 @@ "fields": [ { "name": "containerRepositoriesMaxCapacity", - "description": "The maximum concurrency of container repository sync for this secondary node", + "description": "The maximum concurrency of container repository sync for this secondary node.", "args": [ ], @@ -28456,7 +28572,7 @@ }, { "name": "enabled", - "description": "Indicates whether this Geo node is enabled", + "description": "Indicates whether this Geo node is enabled.", "args": [ ], @@ -28470,7 +28586,7 @@ }, { "name": "filesMaxCapacity", - "description": "The maximum concurrency of LFS/attachment backfill for this secondary node", + "description": "The maximum concurrency of LFS/attachment backfill for this secondary node.", "args": [ ], @@ -28484,7 +28600,7 @@ }, { "name": "id", - "description": "ID of this GeoNode", + "description": "ID of this GeoNode.", "args": [ ], @@ -28502,7 +28618,7 @@ }, { "name": "internalUrl", - "description": "The URL defined on the primary node that secondary nodes should use to contact it", + "description": "The URL defined on the primary node that secondary nodes should use to contact it.", "args": [ ], @@ -28516,7 +28632,7 @@ }, { "name": "mergeRequestDiffRegistries", - "description": "Find merge request diff registries on this Geo node", + "description": "Find merge request diff registries on this Geo node.", "args": [ { "name": "ids", @@ -28587,7 +28703,7 @@ }, { "name": "minimumReverificationInterval", - "description": "The interval (in days) in which the repository verification is valid. Once expired, it will be reverified", + "description": "The interval (in days) in which the repository verification is valid. Once expired, it will be reverified.", "args": [ ], @@ -28601,7 +28717,7 @@ }, { "name": "name", - "description": "The unique identifier for this Geo node", + "description": "The unique identifier for this Geo node.", "args": [ ], @@ -28615,7 +28731,7 @@ }, { "name": "packageFileRegistries", - "description": "Package file registries of the GeoNode", + "description": "Package file registries of the GeoNode.", "args": [ { "name": "ids", @@ -28686,7 +28802,7 @@ }, { "name": "primary", - "description": "Indicates whether this Geo node is the primary", + "description": "Indicates whether this Geo node is the primary.", "args": [ ], @@ -28700,7 +28816,7 @@ }, { "name": "reposMaxCapacity", - "description": "The maximum concurrency of repository backfill for this secondary node", + "description": "The maximum concurrency of repository backfill for this secondary node.", "args": [ ], @@ -28714,7 +28830,7 @@ }, { "name": "selectiveSyncNamespaces", - "description": "The namespaces that should be synced, if `selective_sync_type` == `namespaces`", + "description": "The namespaces that should be synced, if `selective_sync_type` == `namespaces`.", "args": [ { "name": "after", @@ -28767,7 +28883,7 @@ }, { "name": "selectiveSyncShards", - "description": "The repository storages whose projects should be synced, if `selective_sync_type` == `shards`", + "description": "The repository storages whose projects should be synced, if `selective_sync_type` == `shards`.", "args": [ ], @@ -28789,7 +28905,7 @@ }, { "name": "selectiveSyncType", - "description": "Indicates if syncing is limited to only specific groups, or shards", + "description": "Indicates if syncing is limited to only specific groups, or shards.", "args": [ ], @@ -28803,7 +28919,7 @@ }, { "name": "snippetRepositoryRegistries", - "description": "Find snippet repository registries on this Geo node", + "description": "Find snippet repository registries on this Geo node.", "args": [ { "name": "ids", @@ -28874,7 +28990,7 @@ }, { "name": "syncObjectStorage", - "description": "Indicates if this secondary node will replicate blobs in Object Storage", + "description": "Indicates if this secondary node will replicate blobs in Object Storage.", "args": [ ], @@ -28888,7 +29004,7 @@ }, { "name": "terraformStateVersionRegistries", - "description": "Find terraform state version registries on this Geo node", + "description": "Find terraform state version registries on this Geo node.", "args": [ { "name": "ids", @@ -28959,7 +29075,7 @@ }, { "name": "url", - "description": "The user-facing URL for this Geo node", + "description": "The user-facing URL for this Geo node.", "args": [ ], @@ -28973,7 +29089,7 @@ }, { "name": "verificationMaxCapacity", - "description": "The maximum concurrency of repository verification for this secondary node", + "description": "The maximum concurrency of repository verification for this secondary node.", "args": [ ], @@ -32637,7 +32753,7 @@ "fields": [ { "name": "releaseStats", - "description": "Statistics related to releases within the group", + "description": "Statistics related to releases within the group.", "args": [ ], @@ -33582,7 +33698,7 @@ "fields": [ { "name": "description", - "description": "Description of the on-call schedule", + "description": "Description of the on-call schedule.", "args": [ ], @@ -33596,7 +33712,7 @@ }, { "name": "iid", - "description": "Internal ID of the on-call schedule", + "description": "Internal ID of the on-call schedule.", "args": [ ], @@ -33614,7 +33730,7 @@ }, { "name": "name", - "description": "Name of the on-call schedule", + "description": "Name of the on-call schedule.", "args": [ ], @@ -33632,7 +33748,7 @@ }, { "name": "rotations", - "description": "On-call rotations for the on-call schedule", + "description": "On-call rotations for the on-call schedule.", "args": [ { "name": "after", @@ -33689,7 +33805,7 @@ }, { "name": "timezone", - "description": "Time zone of the on-call schedule", + "description": "Time zone of the on-call schedule.", "args": [ ], @@ -33999,7 +34115,7 @@ "fields": [ { "name": "projects", - "description": "Projects selected in Instance Security Dashboard", + "description": "Projects selected in Instance Security Dashboard.", "args": [ { "name": "after", @@ -34056,7 +34172,7 @@ }, { "name": "vulnerabilityGrades", - "description": "Represents vulnerable project counts for each grade", + "description": "Represents vulnerable project counts for each grade.", "args": [ ], @@ -34082,7 +34198,7 @@ }, { "name": "vulnerabilityScanners", - "description": "Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard", + "description": "Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard.", "args": [ { "name": "after", @@ -34135,7 +34251,7 @@ }, { "name": "vulnerabilitySeveritiesCount", - "description": "Counts for each vulnerability severity from projects selected in Instance Security Dashboard", + "description": "Counts for each vulnerability severity from projects selected in Instance Security Dashboard.", "args": [ { "name": "projectId", @@ -37763,7 +37879,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of iteration creation", + "description": "Timestamp of iteration creation.", "args": [ ], @@ -37781,7 +37897,7 @@ }, { "name": "description", - "description": "Description of the iteration", + "description": "Description of the iteration.", "args": [ ], @@ -37809,7 +37925,7 @@ }, { "name": "dueDate", - "description": "Timestamp of the iteration due date", + "description": "Timestamp of the iteration due date.", "args": [ ], @@ -37823,7 +37939,7 @@ }, { "name": "id", - "description": "ID of the iteration", + "description": "ID of the iteration.", "args": [ ], @@ -37841,7 +37957,7 @@ }, { "name": "iid", - "description": "Internal ID of the iteration", + "description": "Internal ID of the iteration.", "args": [ ], @@ -37859,7 +37975,7 @@ }, { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -37873,7 +37989,7 @@ }, { "name": "scopedPath", - "description": "Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts", + "description": "Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.", "args": [ ], @@ -37887,7 +38003,7 @@ }, { "name": "scopedUrl", - "description": "Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts", + "description": "Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.", "args": [ ], @@ -37901,7 +38017,7 @@ }, { "name": "startDate", - "description": "Timestamp of the iteration start date", + "description": "Timestamp of the iteration start date.", "args": [ ], @@ -37915,7 +38031,7 @@ }, { "name": "state", - "description": "State of the iteration", + "description": "State of the iteration.", "args": [ ], @@ -37933,7 +38049,7 @@ }, { "name": "title", - "description": "Title of the iteration", + "description": "Title of the iteration.", "args": [ ], @@ -37951,7 +38067,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of last iteration update", + "description": "Timestamp of last iteration update.", "args": [ ], @@ -37969,7 +38085,7 @@ }, { "name": "webPath", - "description": "Web path of the iteration", + "description": "Web path of the iteration.", "args": [ ], @@ -37987,7 +38103,7 @@ }, { "name": "webUrl", - "description": "Web URL of the iteration", + "description": "Web URL of the iteration.", "args": [ ], @@ -42297,7 +42413,7 @@ }, { "name": "mergeRequestDiffId", - "description": "ID of the Merge Request diff", + "description": "ID of the Merge Request diff.", "args": [ ], @@ -43997,7 +44113,7 @@ "fields": [ { "name": "fileName", - "description": "File name of the metric image", + "description": "File name of the metric image.", "args": [ ], @@ -44011,7 +44127,7 @@ }, { "name": "filePath", - "description": "File path of the metric image", + "description": "File path of the metric image.", "args": [ ], @@ -44025,7 +44141,7 @@ }, { "name": "id", - "description": "ID of the metric upload", + "description": "ID of the metric upload.", "args": [ ], @@ -44043,7 +44159,7 @@ }, { "name": "iid", - "description": "Internal ID of the metric upload", + "description": "Internal ID of the metric upload.", "args": [ ], @@ -44061,7 +44177,7 @@ }, { "name": "url", - "description": "URL of the metric source", + "description": "URL of the metric source.", "args": [ ], @@ -44527,7 +44643,7 @@ }, { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -45856,6 +45972,33 @@ "deprecationReason": null }, { + "name": "dastProfileRun", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastProfileRunInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastProfileRunPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "dastScannerProfileCreate", "description": null, "args": [ @@ -52055,7 +52198,7 @@ }, { "name": "packageFileId", - "description": "ID of the PackageFile", + "description": "ID of the PackageFile.", "args": [ ], @@ -64751,7 +64894,7 @@ "fields": [ { "name": "author", - "description": "Author of the requirement", + "description": "Author of the requirement.", "args": [ ], @@ -64769,7 +64912,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the requirement was created", + "description": "Timestamp of when the requirement was created.", "args": [ ], @@ -64787,7 +64930,7 @@ }, { "name": "description", - "description": "Description of the requirement", + "description": "Description of the requirement.", "args": [ ], @@ -64815,7 +64958,7 @@ }, { "name": "id", - "description": "ID of the requirement", + "description": "ID of the requirement.", "args": [ ], @@ -64833,7 +64976,7 @@ }, { "name": "iid", - "description": "Internal ID of the requirement", + "description": "Internal ID of the requirement.", "args": [ ], @@ -64851,7 +64994,7 @@ }, { "name": "lastTestReportManuallyCreated", - "description": "Indicates if latest test report was created by user", + "description": "Indicates if latest test report was created by user.", "args": [ ], @@ -64865,7 +65008,7 @@ }, { "name": "lastTestReportState", - "description": "Latest requirement test report state", + "description": "Latest requirement test report state.", "args": [ ], @@ -64879,7 +65022,7 @@ }, { "name": "project", - "description": "Project to which the requirement belongs", + "description": "Project to which the requirement belongs.", "args": [ ], @@ -64897,7 +65040,7 @@ }, { "name": "state", - "description": "State of the requirement", + "description": "State of the requirement.", "args": [ ], @@ -64915,7 +65058,7 @@ }, { "name": "testReports", - "description": "Test reports of the requirement", + "description": "Test reports of the requirement.", "args": [ { "name": "sort", @@ -64978,7 +65121,7 @@ }, { "name": "title", - "description": "Title of the requirement", + "description": "Title of the requirement.", "args": [ ], @@ -65006,7 +65149,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the requirement was last updated", + "description": "Timestamp of when the requirement was last updated.", "args": [ ], @@ -65293,7 +65436,7 @@ "fields": [ { "name": "archived", - "description": "Number of archived requirements", + "description": "Number of archived requirements.", "args": [ ], @@ -65307,7 +65450,7 @@ }, { "name": "opened", - "description": "Number of opened requirements", + "description": "Number of opened requirements.", "args": [ ], @@ -67300,7 +67443,7 @@ "fields": [ { "name": "requestMethod", - "description": "The HTTP request method used to access the URL", + "description": "The HTTP request method used to access the URL.", "args": [ ], @@ -67314,7 +67457,7 @@ }, { "name": "url", - "description": "The URL scanned by the scanner", + "description": "The URL scanned by the scanner.", "args": [ ], @@ -67564,7 +67707,7 @@ "fields": [ { "name": "scannedResources", - "description": "A list of the first 20 scanned resources", + "description": "A list of the first 20 scanned resources.", "args": [ { "name": "after", @@ -67617,7 +67760,7 @@ }, { "name": "scannedResourcesCount", - "description": "Total number of scanned resources", + "description": "Total number of scanned resources.", "args": [ ], @@ -67631,7 +67774,7 @@ }, { "name": "scannedResourcesCsvPath", - "description": "Path to download all the scanned resources in CSV format", + "description": "Path to download all the scanned resources in CSV format.", "args": [ ], @@ -67645,7 +67788,7 @@ }, { "name": "vulnerabilitiesCount", - "description": "Total number of vulnerabilities", + "description": "Total number of vulnerabilities.", "args": [ ], @@ -70995,7 +71138,7 @@ }, { "name": "snippetRepositoryId", - "description": "ID of the Snippet Repository", + "description": "ID of the Snippet Repository.", "args": [ ], @@ -72374,7 +72517,7 @@ }, { "name": "terraformStateVersionId", - "description": "ID of the terraform state version", + "description": "ID of the terraform state version.", "args": [ ], @@ -72517,7 +72660,7 @@ "fields": [ { "name": "author", - "description": "Author of the test report", + "description": "Author of the test report.", "args": [ ], @@ -72531,7 +72674,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the test report was created", + "description": "Timestamp of when the test report was created.", "args": [ ], @@ -72549,7 +72692,7 @@ }, { "name": "id", - "description": "ID of the test report", + "description": "ID of the test report.", "args": [ ], @@ -72567,7 +72710,7 @@ }, { "name": "state", - "description": "State of the test report", + "description": "State of the test report.", "args": [ ], @@ -72743,7 +72886,7 @@ "fields": [ { "name": "complete", - "description": "Completed issues metrics", + "description": "Completed issues metrics.", "args": [ ], @@ -72757,7 +72900,7 @@ }, { "name": "incomplete", - "description": "Incomplete issues metrics", + "description": "Incomplete issues metrics.", "args": [ ], @@ -72771,7 +72914,7 @@ }, { "name": "total", - "description": "Total issues metrics", + "description": "Total issues metrics.", "args": [ ], @@ -72798,7 +72941,7 @@ "fields": [ { "name": "count", - "description": "The count metric", + "description": "The count metric.", "args": [ ], @@ -72816,7 +72959,7 @@ }, { "name": "weight", - "description": "The weight metric", + "description": "The weight metric.", "args": [ ], @@ -72847,7 +72990,7 @@ "fields": [ { "name": "burnupTimeSeries", - "description": "Daily scope and completed totals for burnup charts", + "description": "Daily scope and completed totals for burnup charts.", "args": [ ], @@ -72869,7 +73012,7 @@ }, { "name": "stats", - "description": "Represents the time report stats for the timebox", + "description": "Represents the time report stats for the timebox.", "args": [ ], @@ -72896,7 +73039,7 @@ "fields": [ { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -72971,7 +73114,7 @@ "fields": [ { "name": "issue", - "description": "The issue that logged time was added to", + "description": "The issue that logged time was added to.", "args": [ ], @@ -72985,7 +73128,7 @@ }, { "name": "note", - "description": "The note where the quick action to add the logged time was executed", + "description": "The note where the quick action to add the logged time was executed.", "args": [ ], @@ -72999,7 +73142,7 @@ }, { "name": "spentAt", - "description": "Timestamp of when the time tracked was spent at", + "description": "Timestamp of when the time tracked was spent at.", "args": [ ], @@ -73013,7 +73156,7 @@ }, { "name": "timeSpent", - "description": "The time spent displayed in seconds", + "description": "The time spent displayed in seconds.", "args": [ ], @@ -73031,7 +73174,7 @@ }, { "name": "user", - "description": "The user that logged the time", + "description": "The user that logged the time.", "args": [ ], @@ -78917,7 +79060,7 @@ }, { "name": "date", - "description": "Date for the count", + "description": "Date for the count.", "args": [ ], @@ -79007,7 +79150,7 @@ }, { "name": "total", - "description": "Total number of vulnerabilities on a particular day", + "description": "Total number of vulnerabilities on a particular day.", "args": [ ], @@ -79056,7 +79199,7 @@ "fields": [ { "name": "count", - "description": "Number of vulnerabilities", + "description": "Number of vulnerabilities.", "args": [ ], @@ -79070,7 +79213,7 @@ }, { "name": "day", - "description": "Date for the count", + "description": "Date for the count.", "args": [ ], @@ -79084,7 +79227,7 @@ }, { "name": "severity", - "description": "Severity of the counted vulnerabilities", + "description": "Severity of the counted vulnerabilities.", "args": [ ], @@ -79345,7 +79488,7 @@ "fields": [ { "name": "confirmedAt", - "description": "Timestamp of when the vulnerability state was changed to confirmed", + "description": "Timestamp of when the vulnerability state was changed to confirmed.", "args": [ ], @@ -79373,7 +79516,7 @@ }, { "name": "description", - "description": "Description of the vulnerability", + "description": "Description of the vulnerability.", "args": [ ], @@ -79387,7 +79530,7 @@ }, { "name": "details", - "description": "Details of the vulnerability", + "description": "Details of the vulnerability.", "args": [ ], @@ -79413,7 +79556,7 @@ }, { "name": "detectedAt", - "description": "Timestamp of when the vulnerability was first detected", + "description": "Timestamp of when the vulnerability was first detected.", "args": [ ], @@ -79488,7 +79631,7 @@ }, { "name": "dismissedAt", - "description": "Timestamp of when the vulnerability state was changed to dismissed", + "description": "Timestamp of when the vulnerability state was changed to dismissed.", "args": [ ], @@ -79516,7 +79659,7 @@ }, { "name": "externalIssueLinks", - "description": "List of external issue links related to the vulnerability", + "description": "List of external issue links related to the vulnerability.", "args": [ { "name": "after", @@ -79587,7 +79730,7 @@ }, { "name": "id", - "description": "GraphQL ID of the vulnerability", + "description": "GraphQL ID of the vulnerability.", "args": [ ], @@ -79631,7 +79774,7 @@ }, { "name": "issueLinks", - "description": "List of issue links related to the vulnerability", + "description": "List of issue links related to the vulnerability.", "args": [ { "name": "linkType", @@ -79698,7 +79841,7 @@ }, { "name": "location", - "description": "Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability", + "description": "Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.", "args": [ ], @@ -79797,7 +79940,7 @@ }, { "name": "project", - "description": "The project on which the vulnerability was found", + "description": "The project on which the vulnerability was found.", "args": [ ], @@ -79825,7 +79968,7 @@ }, { "name": "resolvedAt", - "description": "Timestamp of when the vulnerability state was changed to resolved", + "description": "Timestamp of when the vulnerability state was changed to resolved.", "args": [ ], @@ -79853,7 +79996,7 @@ }, { "name": "resolvedOnDefaultBranch", - "description": "Indicates whether the vulnerability is fixed on the default branch or not", + "description": "Indicates whether the vulnerability is fixed on the default branch or not.", "args": [ ], @@ -79913,7 +80056,7 @@ }, { "name": "title", - "description": "Title of the vulnerability", + "description": "Title of the vulnerability.", "args": [ ], @@ -79927,7 +80070,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes attached to the vulnerability", + "description": "Number of user notes attached to the vulnerability.", "args": [ ], @@ -79963,7 +80106,7 @@ }, { "name": "vulnerabilityPath", - "description": "URL to the vulnerability's details page", + "description": "URL to the vulnerability's details page.", "args": [ ], @@ -81624,7 +81767,7 @@ "fields": [ { "name": "externalIssue", - "description": "The external issue attached to the issue link", + "description": "The external issue attached to the issue link.", "args": [ ], @@ -81638,7 +81781,7 @@ }, { "name": "id", - "description": "GraphQL ID of the external issue link", + "description": "GraphQL ID of the external issue link.", "args": [ ], @@ -81656,7 +81799,7 @@ }, { "name": "linkType", - "description": "Type of the external issue link", + "description": "Type of the external issue link.", "args": [ ], @@ -82102,7 +82245,7 @@ "fields": [ { "name": "externalId", - "description": "External ID of the vulnerability identifier", + "description": "External ID of the vulnerability identifier.", "args": [ ], @@ -82116,7 +82259,7 @@ }, { "name": "externalType", - "description": "External type of the vulnerability identifier", + "description": "External type of the vulnerability identifier.", "args": [ ], @@ -82130,7 +82273,7 @@ }, { "name": "name", - "description": "Name of the vulnerability identifier", + "description": "Name of the vulnerability identifier.", "args": [ ], @@ -82144,7 +82287,7 @@ }, { "name": "url", - "description": "URL of the vulnerability identifier", + "description": "URL of the vulnerability identifier.", "args": [ ], @@ -82171,7 +82314,7 @@ "fields": [ { "name": "id", - "description": "GraphQL ID of the vulnerability", + "description": "GraphQL ID of the vulnerability.", "args": [ ], @@ -82189,7 +82332,7 @@ }, { "name": "issue", - "description": "The issue attached to issue link", + "description": "The issue attached to issue link.", "args": [ ], @@ -82207,7 +82350,7 @@ }, { "name": "linkType", - "description": "Type of the issue link", + "description": "Type of the issue link.", "args": [ ], @@ -82414,7 +82557,7 @@ "fields": [ { "name": "dependency", - "description": "Dependency containing the vulnerability", + "description": "Dependency containing the vulnerability.", "args": [ ], @@ -82428,7 +82571,7 @@ }, { "name": "image", - "description": "Name of the vulnerable container image", + "description": "Name of the vulnerable container image.", "args": [ ], @@ -82442,7 +82585,7 @@ }, { "name": "operatingSystem", - "description": "Operating system that runs on the vulnerable container image", + "description": "Operating system that runs on the vulnerable container image.", "args": [ ], @@ -82469,7 +82612,7 @@ "fields": [ { "name": "blobPath", - "description": "Blob path to the vulnerable file", + "description": "Blob path to the vulnerable file.", "args": [ ], @@ -82483,7 +82626,7 @@ }, { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -82497,7 +82640,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -82511,7 +82654,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -82525,7 +82668,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -82539,7 +82682,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -82566,7 +82709,7 @@ "fields": [ { "name": "hostname", - "description": "Domain name of the vulnerable request", + "description": "Domain name of the vulnerable request.", "args": [ ], @@ -82580,7 +82723,7 @@ }, { "name": "param", - "description": "Query parameter for the URL on which the vulnerability occurred", + "description": "Query parameter for the URL on which the vulnerability occurred.", "args": [ ], @@ -82594,7 +82737,7 @@ }, { "name": "path", - "description": "URL path and query string of the vulnerable request", + "description": "URL path and query string of the vulnerable request.", "args": [ ], @@ -82608,7 +82751,7 @@ }, { "name": "requestMethod", - "description": "HTTP method of the vulnerable request", + "description": "HTTP method of the vulnerable request.", "args": [ ], @@ -82635,7 +82778,7 @@ "fields": [ { "name": "blobPath", - "description": "Blob path to the vulnerable file", + "description": "Blob path to the vulnerable file.", "args": [ ], @@ -82649,7 +82792,7 @@ }, { "name": "dependency", - "description": "Dependency containing the vulnerability", + "description": "Dependency containing the vulnerability.", "args": [ ], @@ -82663,7 +82806,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -82690,7 +82833,7 @@ "fields": [ { "name": "blobPath", - "description": "Blob path to the vulnerable file", + "description": "Blob path to the vulnerable file.", "args": [ ], @@ -82704,7 +82847,7 @@ }, { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -82718,7 +82861,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -82732,7 +82875,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -82746,7 +82889,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -82760,7 +82903,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -82787,7 +82930,7 @@ "fields": [ { "name": "blobPath", - "description": "Blob path to the vulnerable file", + "description": "Blob path to the vulnerable file.", "args": [ ], @@ -82801,7 +82944,7 @@ }, { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -82815,7 +82958,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -82829,7 +82972,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -82843,7 +82986,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -82857,7 +83000,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -83316,7 +83459,7 @@ "fields": [ { "name": "externalId", - "description": "External ID of the vulnerability scanner", + "description": "External ID of the vulnerability scanner.", "args": [ ], @@ -83330,7 +83473,7 @@ }, { "name": "name", - "description": "Name of the vulnerability scanner", + "description": "Name of the vulnerability scanner.", "args": [ ], @@ -83344,7 +83487,7 @@ }, { "name": "reportType", - "description": "Type of the vulnerability report", + "description": "Type of the vulnerability report.", "args": [ ], @@ -83358,7 +83501,7 @@ }, { "name": "vendor", - "description": "Vendor of the vulnerability scanner", + "description": "Vendor of the vulnerability scanner.", "args": [ ], @@ -83747,7 +83890,7 @@ "fields": [ { "name": "package", - "description": "The package associated with the vulnerable dependency", + "description": "The package associated with the vulnerable dependency.", "args": [ ], @@ -83761,7 +83904,7 @@ }, { "name": "version", - "description": "The version of the vulnerable dependency", + "description": "The version of the vulnerable dependency.", "args": [ ], @@ -83788,7 +83931,7 @@ "fields": [ { "name": "name", - "description": "The name of the vulnerable package", + "description": "The name of the vulnerable package.", "args": [ ], @@ -83815,7 +83958,7 @@ "fields": [ { "name": "count", - "description": "Number of projects within this grade", + "description": "Number of projects within this grade.", "args": [ ], @@ -83833,7 +83976,7 @@ }, { "name": "grade", - "description": "Grade based on the highest severity vulnerability present", + "description": "Grade based on the highest severity vulnerability present.", "args": [ ], @@ -83851,7 +83994,7 @@ }, { "name": "projects", - "description": "Projects within this grade", + "description": "Projects within this grade.", "args": [ { "name": "after", 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 diff --git a/doc/development/elasticsearch.md b/doc/development/elasticsearch.md index 10fa331e1dd..3392bd1fbf6 100644 --- a/doc/development/elasticsearch.md +++ b/doc/development/elasticsearch.md @@ -69,7 +69,7 @@ The `whitespace` tokenizer was selected in order to have more control over how t Please see the `code` filter for an explanation on how tokens are split. NOTE: -Currently the [Elasticsearch code_analyzer doesn't account for all code cases](../integration/elasticsearch.md#known-issues). +The [Elasticsearch code_analyzer doesn't account for all code cases](../integration/elasticsearch.md#elasticsearch-code_analyzer-doesnt-account-for-all-code-cases). #### `code_search_analyzer` diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md index d217d472bd2..964f9e12482 100644 --- a/doc/integration/elasticsearch.md +++ b/doc/integration/elasticsearch.md @@ -668,6 +668,23 @@ However, some larger installations may wish to tune the merge policy settings: - Do not do a [force merge](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html "Force Merge") to remove deleted documents. A warning in the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html "Force Merge") states that this can lead to very large segments that may never get reclaimed, and can also cause significant performance or availability issues. +## Reverting to Basic Search + +Sometimes there may be issues with your Elasticsearch index data and as such +GitLab will allow you to revert to "basic search" when there are no search +results and assuming that basic search is supported in that scope. This "basic +search" will behave as though you don't have Advanced Search enabled at all for +your instance and search using other data sources (such as PostgreSQL data and Git +data). + +## Data recovery: Elasticsearch is a secondary data store only + +The use of Elasticsearch in GitLab is only ever as a secondary data store. +This means that all of the data stored in Elasticsearch can always be derived +again from other data sources, specifically PostgreSQL and Gitaly. Therefore, if +the Elasticsearch data store is ever corrupted for whatever reason, you can +simply reindex everything from scratch. + ## Troubleshooting One of the most valuable tools for identifying issues with the Elasticsearch @@ -849,27 +866,12 @@ problem. There is a [more structured, lower-level troubleshooting document](../administration/troubleshooting/elasticsearch.md) for when you experience other issues, including poor performance. -### Known issues - -[Elasticsearch `code_analyzer` doesn't account for all code cases](https://gitlab.com/groups/gitlab-org/-/epics/3621). +### Elasticsearch `code_analyzer` doesn't account for all code cases The `code_analyzer` pattern and filter configuration is being evaluated for improvement. We have fixed [most edge cases](https://gitlab.com/groups/gitlab-org/-/epics/3621#note_363429094) that were not returning expected search results due to our pattern and filter configuration. Improvements to the `code_analyzer` pattern and filters are being discussed in [epic 3621](https://gitlab.com/groups/gitlab-org/-/epics/3621). -### Reverting to Basic Search - -Sometimes there may be issues with your Elasticsearch index data and as such -GitLab will allow you to revert to "basic search" when there are no search -results and assuming that basic search is supported in that scope. This "basic -search" will behave as though you don't have Advanced Search enabled at all for -your instance and search using other data sources (such as PostgreSQL data and Git -data). - -### Data recovery: Elasticsearch is a secondary data store only +### Some binary files may not be searchable by name -The use of Elasticsearch in GitLab is only ever as a secondary data store. -This means that all of the data stored in Elasticsearch can always be derived -again from other data sources, specifically PostgreSQL and Gitaly. Therefore, if -the Elasticsearch data store is ever corrupted for whatever reason, you can -simply reindex everything from scratch. +In GitLab 13.9, a change was made where [binary file names are being indexed](https://gitlab.com/gitlab-org/gitlab/-/issues/301083). However, without indexing all projects' data from scratch, only binary files that are added or updated after the GitLab 13.9 release are searchable. diff --git a/doc/user/admin_area/settings/account_and_limit_settings.md b/doc/user/admin_area/settings/account_and_limit_settings.md index 641e3f9f104..70416c224c7 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -194,10 +194,7 @@ To do this: ## Optional enforcement of Personal Access Token expiry **(ULTIMATE SELF)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214723) in GitLab Ultimate 13.1. -> - It is deployed behind a feature flag, disabled by default. -> - It is disabled on GitLab.com. -> - It is not recommended for production use. -> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-optional-enforcement-of-personal-access-token-expiry-feature). **(FREE SELF)** +> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/296881) in GitLab 13.9. GitLab administrators can choose to prevent personal access tokens from expiring automatically. The tokens are usable after the expiry date, unless they are revoked explicitly. @@ -208,23 +205,6 @@ To do this: 1. Expand the **Account and limit** section. 1. Uncheck the **Enforce personal access token expiration** checkbox. -### Enable or disable optional enforcement of Personal Access Token expiry Feature **(FREE SELF)** - -Optional Enforcement of Personal Access Token Expiry is deployed behind a feature flag and is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) can enable it for your instance from the [rails console](../../../administration/feature_flags.md#start-the-gitlab-rails-console). - -To enable it: - -```ruby -Feature.enable(:enforce_pat_expiration) -``` - -To disable it: - -```ruby -Feature.disable(:enforce_pat_expiration) -``` - ## Disabling user profile name changes **(PREMIUM SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/24605) in GitLab 12.7. |