diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/broadcast_messages.md | 6 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 30 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 91 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 12 |
4 files changed, 136 insertions, 3 deletions
diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index ce68eec87ff..6a9a0ba745a 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -4,7 +4,7 @@ Broadcast messages API operates on [broadcast messages](../user/admin_area/broadcast_messages.md). -The broadcast message API is only accessible to administrators. All requests by: +As of GitLab 12.8, GET requests do not require authentication. All other broadcast message API endpoints are accessible only to administrators. Non-GET requests by: - Guests will result in `401 Unauthorized`. - Regular users will result in `403 Forbidden`. @@ -20,7 +20,7 @@ GET /broadcast_messages Example request: ```sh -curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/broadcast_messages +curl https://gitlab.example.com/api/v4/broadcast_messages ``` Example response: @@ -57,7 +57,7 @@ Parameters: Example request: ```sh -curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/broadcast_messages/1 +curl https://gitlab.example.com/api/v4/broadcast_messages/1 ``` Example response: diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 4e083142514..39b34e72e24 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -6066,6 +6066,11 @@ type SentryDetailedError { culprit: String! """ + External Base URL of the Sentry Instance + """ + externalBaseUrl: String! + + """ External URL of the error """ externalUrl: String! @@ -6101,6 +6106,11 @@ type SentryDetailedError { gitlabCommitPath: String """ + URL of GitLab Issue + """ + gitlabIssuePath: String + + """ ID (global ID) of the error """ id: ID! @@ -6156,6 +6166,11 @@ type SentryDetailedError { status: SentryErrorStatus! """ + Tags associated with the Sentry Error + """ + tags: SentryErrorTags! + + """ Title of the error """ title: String! @@ -6209,6 +6224,21 @@ enum SentryErrorStatus { } """ +State of a Sentry error +""" +type SentryErrorTags { + """ + Severity level of the Sentry Error + """ + level: String + + """ + Logger of the Sentry Error + """ + logger: String +} + +""" Represents a snippet entry """ type Snippet implements Noteable { diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 5c1c05d6d4e..2d2bcaf32bd 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -16747,6 +16747,24 @@ "deprecationReason": null }, { + "name": "externalBaseUrl", + "description": "External Base URL of the Sentry Instance", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "externalUrl", "description": "External URL of the error", "args": [ @@ -16865,6 +16883,20 @@ "deprecationReason": null }, { + "name": "gitlabIssuePath", + "description": "URL of GitLab Issue", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "id", "description": "ID (global ID) of the error", "args": [ @@ -17051,6 +17083,24 @@ "deprecationReason": null }, { + "name": "tags", + "description": "Tags associated with the Sentry Error", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SentryErrorTags", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "title", "description": "Title of the error", "args": [ @@ -17198,6 +17248,47 @@ }, { "kind": "OBJECT", + "name": "SentryErrorTags", + "description": "State of a Sentry error", + "fields": [ + { + "name": "level", + "description": "Severity level of the Sentry Error", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logger", + "description": "Logger of the Sentry Error", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "GrafanaIntegration", "description": null, "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 210554243a8..790e55d437f 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -923,6 +923,7 @@ Autogenerated return type of RemoveAwardEmoji | --- | ---- | ---------- | | `count` | Int! | Count of occurrences | | `culprit` | String! | Culprit of the error | +| `externalBaseUrl` | String! | External Base URL of the Sentry Instance | | `externalUrl` | String! | External URL of the error | | `firstReleaseLastCommit` | String | Commit the error was first seen | | `firstReleaseShortVersion` | String | Release version the error was first seen | @@ -930,6 +931,7 @@ Autogenerated return type of RemoveAwardEmoji | `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error | | `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version | | `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error | +| `gitlabIssuePath` | String | URL of GitLab Issue | | `id` | ID! | ID (global ID) of the error | | `lastReleaseLastCommit` | String | Commit the error was last seen | | `lastReleaseShortVersion` | String | Release version the error was last seen | @@ -941,6 +943,7 @@ Autogenerated return type of RemoveAwardEmoji | `sentryProjectSlug` | String! | Slug of the project affected by the error | | `shortId` | String! | Short ID (Sentry ID) of the error | | `status` | SentryErrorStatus! | Status of the error | +| `tags` | SentryErrorTags! | Tags associated with the Sentry Error | | `title` | String! | Title of the error | | `type` | String! | Type of the error | | `userCount` | Int! | Count of users affected by the error | @@ -952,6 +955,15 @@ Autogenerated return type of RemoveAwardEmoji | `count` | Int! | Count of errors received since the previously recorded time | | `time` | Time! | Time the error frequency stats were recorded | +## SentryErrorTags + +State of a Sentry error + +| Name | Type | Description | +| --- | ---- | ---------- | +| `level` | String | Severity level of the Sentry Error | +| `logger` | String | Logger of the Sentry Error | + ## Snippet Represents a snippet entry |