From 0e0df204c1a0d859ccbbe1be83a5e09a53381f17 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 10 May 2023 12:09:12 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/dora/metrics.md | 2 - doc/api/graphql/reference/index.md | 85 ++++++++++++++++++++++++++++---------- 2 files changed, 64 insertions(+), 23 deletions(-) (limited to 'doc/api') diff --git a/doc/api/dora/metrics.md b/doc/api/dora/metrics.md index 9d81a82f520..d30194c3da0 100644 --- a/doc/api/dora/metrics.md +++ b/doc/api/dora/metrics.md @@ -28,7 +28,6 @@ GET /projects/:id/dora/metrics | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding) can be accessed by the authenticated user. | | `metric` | string | yes | One of `deployment_frequency`, `lead_time_for_changes`, `time_to_restore_service` or `change_failure_rate`. | | `end_date` | string | no | Date range to end at. ISO 8601 Date format, for example `2021-03-01`. Default is the current date. | -| `environment_tier` | string | no | The [tier of the environment](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. Deprecated, use `environment_tiers`. | | `environment_tiers` | array of strings | no | The [tiers of the environments](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. | | `interval` | string | no | The bucketing interval. One of `all`, `monthly` or `daily`. Default is `daily`. | | `start_date` | string | no | Date range to start from. ISO 8601 Date format, for example `2021-03-01`. Default is 3 months ago. | @@ -69,7 +68,6 @@ GET /groups/:id/dora/metrics | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding) can be accessed by the authenticated user. | | `metric` | string | yes | One of `deployment_frequency`, `lead_time_for_changes`, `time_to_restore_service` or `change_failure_rate`. | | `end_date` | string | no | Date range to end at. ISO 8601 Date format, for example `2021-03-01`. Default is the current date. | -| `environment_tier` | string | no | The [tier of the environment](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. Deprecated, use `environment_tiers`. | | `environment_tiers` | array of strings | no | The [tiers of the environments](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. | | `interval` | string | no | The bucketing interval. One of `all`, `monthly` or `daily`. Default is `daily`. | | `start_date` | string | no | Date range to start from. ISO 8601 Date format, for example `2021-03-01`. Default is 3 months ago. | diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 18e44336223..412556b6657 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -3563,6 +3563,44 @@ Input type: `InstanceExternalAuditEventDestinationCreateInput` | `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | | `instanceExternalAuditEventDestination` | [`InstanceExternalAuditEventDestination`](#instanceexternalauditeventdestination) | Destination created. | +### `Mutation.instanceExternalAuditEventDestinationDestroy` + +Input type: `InstanceExternalAuditEventDestinationDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `id` | [`AuditEventsInstanceExternalAuditEventDestinationID!`](#auditeventsinstanceexternalauditeventdestinationid) | ID of the external instance audit event destination to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.instanceExternalAuditEventDestinationUpdate` + +Input type: `InstanceExternalAuditEventDestinationUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `destinationUrl` | [`String`](#string) | Destination URL to change. | +| `id` | [`AuditEventsInstanceExternalAuditEventDestinationID!`](#auditeventsinstanceexternalauditeventdestinationid) | ID of the external instance audit event destination to update. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| `instanceExternalAuditEventDestination` | [`InstanceExternalAuditEventDestination`](#instanceexternalauditeventdestination) | Updated destination. | + ### `Mutation.issuableResourceLinkCreate` Input type: `IssuableResourceLinkCreateInput` @@ -13801,7 +13839,6 @@ Returns [`[DoraMetric!]`](#dorametric). | Name | Type | Description | | ---- | ---- | ----------- | | `endDate` | [`Date`](#date) | Date range to end at. Default is the current date. | -| `environmentTier` **{warning-solid}** | [`DeploymentTier`](#deploymenttier) | **Deprecated** in 15.2. Superseded by `environment_tiers` param. | | `environmentTiers` | [`[DeploymentTier!]`](#deploymenttier) | Deployment tiers of the environments to return. Defaults to `[PRODUCTION]`. | | `interval` | [`DoraMetricBucketingInterval`](#dorametricbucketinginterval) | How the metric should be aggregated. Defaults to `DAILY`. In the case of `ALL`, the `date` field in the response will be `null`. | | `metric` **{warning-solid}** | [`DoraMetricType`](#dorametrictype) | **Deprecated** in 15.10. Superseded by metrics fields. See `DoraMetric` type. | @@ -15789,11 +15826,11 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | | `projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `GroupValueStreamAnalyticsFlowMetrics.deploymentCount` @@ -15805,9 +15842,9 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | Name | Type | Description | | ---- | ---- | ----------- | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `GroupValueStreamAnalyticsFlowMetrics.issueCount` @@ -15821,11 +15858,11 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | | `projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount` @@ -15839,11 +15876,11 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | | `projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `GroupValueStreamAnalyticsFlowMetrics.leadTime` @@ -15857,11 +15894,11 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | | `projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ### `GroupWikiRepositoryRegistry` @@ -20447,10 +20484,10 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `ProjectValueStreamAnalyticsFlowMetrics.deploymentCount` @@ -20462,8 +20499,8 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | Name | Type | Description | | ---- | ---- | ----------- | -| `from` | [`Time!`](#time) | After the date. | -| `to` | [`Time!`](#time) | Before the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `ProjectValueStreamAnalyticsFlowMetrics.issueCount` @@ -20477,10 +20514,10 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `ProjectValueStreamAnalyticsFlowMetrics.issuesCompletedCount` @@ -20494,10 +20531,10 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ##### `ProjectValueStreamAnalyticsFlowMetrics.leadTime` @@ -20511,10 +20548,10 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric). | ---- | ---- | ----------- | | `assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | | `authorUsername` | [`String`](#string) | Username of the author of the issue. | -| `from` | [`Time!`](#time) | After the date. | +| `from` | [`Time!`](#time) | Timestamp marking the start date and time. | | `labelNames` | [`[String!]`](#string) | Labels applied to the issue. | | `milestoneTitle` | [`String`](#string) | Milestone applied to the issue. | -| `to` | [`Time!`](#time) | Before the date. | +| `to` | [`Time!`](#time) | Timestamp marking the end date and time. | ### `ProjectWikiRepositoryRegistry` @@ -25701,6 +25738,12 @@ A `AuditEventsExternalAuditEventDestinationID` is a global ID. It is encoded as An example `AuditEventsExternalAuditEventDestinationID` is: `"gid://gitlab/AuditEvents::ExternalAuditEventDestination/1"`. +### `AuditEventsInstanceExternalAuditEventDestinationID` + +A `AuditEventsInstanceExternalAuditEventDestinationID` is a global ID. It is encoded as a string. + +An example `AuditEventsInstanceExternalAuditEventDestinationID` is: `"gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1"`. + ### `AuditEventsStreamingHeaderID` A `AuditEventsStreamingHeaderID` is a global ID. It is encoded as a string. -- cgit v1.2.3