From c2df26ce079c14b27cfdf4fc10c9c7a55c62f48b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?= <“nicoshishkinatlogz@outlook.com”> Date: Mon, 17 Oct 2022 15:17:00 +0100 Subject: [PATCH 01/15] Grafana API --- _source/api/logzio-public-api.yml | 1595 ++++++++++++++++++++++++++++- 1 file changed, 1561 insertions(+), 34 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 68fcdb683..f00fb1189 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -302,6 +302,9 @@ x-tagGroups: - Connect to S3 Buckets - name: Metrics API Gateway tags: + - Grafana contact points + - Grafana data source + - Grafana alerting provisioning - Grafana annotations - Grafana dashboards - Grafana dashboard search @@ -310,6 +313,1561 @@ x-tagGroups: paths: # ::::: GRAFANA + + v1/provisioning/contact-points: + get: + operationId: RouteGetContactpoints + summary: Get all contact points + description: >- + Get all contact points. + tags: + - Grafana contact points + parameters: + - in: query + name: name + type: string + schema: + description: >- + Name to filter by. + responses: + 200: + description: ContactPoints + schema: + type: array + items: + type: object + properties: + disableResolveMessage: + type: boolean + name: + type: string + example: webhook_1 + provenance: + type: string + example: string + settings: + type: object + properties: + type: + type: string + example: webhook + uid: + type: string + example: my_external_reference + + post: + operationId: RoutePostContactpoints + summary: Create a contact point + description: >- + Create a contact point. + tags: + - Grafana contact points + parameters: + - in: body + name: body + schema: + type: object + properties: + disableResolveMessage: + type: boolean + name: + type: string + example: webhook_1 + settings: + type: object + properties: + type: + type: string + example: webhook + uid: + type: string + example: my_external_reference + responses: + 202: + description: ContactPoints + schema: + type: object + properties: + definitions: + disableResolveMessage: + type: boolean + name: + type: string + example: webhook_1 + provenance: + type: string + example: string + settings: + type: object + properties: + type: + type: string + example: webhook + uid: + type: string + example: my_external_reference + 400: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Error message + + + v1/provisioning/contact-points/{UID}: + delete: + operationId: RouteDeleteContactpoints + summary: Delete a contact point + description: >- + Delete a contact point. + tags: + - Grafana contact points + parameters: + - in: path + name: UID + type: string + required: true + schema: + description: >- + Contact point unique identifier. + responses: + 204: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + put: + operationId: RouteUpdateContactpoints + summary: Update a contact point + description: >- + Update a contact point. + tags: + - Grafana contact points + parameters: + - in: path + name: UID + type: string + required: true + schema: + description: >- + Contact point unique identifier. + - in: body + name: body + schema: + type: object + properties: + disableResolveMessage: + type: boolean + name: + type: string + example: webhook_1 + settings: + type: object + properties: + type: + type: string + example: webhook + uid: + type: string + example: my_external_reference + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + 204: + description: Acknowledged + schema: + type: object + properties: + 400: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Validator error. + + + v1/provisioning/contact-points/{UID}: + delete: + operationId: RouteResetPolicyTree + summary: Clears the notification policy tree + description: >- + Clears the notification policy tree. + tags: + - Grafana contact points + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + get: + operationId: RouteGetPolicyTree + summary: Get the notification policy tree + description: >- + Get the notification policy tree. + tags: + - Grafana contact points + responses: + 202: + description: Not Found + schema: + type: object + properties: + continue: + type: boolean + group_by: + type: array + items: + type: string + example: string + group_interval: + type: string + example: string + group_wait: + type: string + example: string + match: + type: object + properties: + additionalProp1: + type: string + example: string + additionalProp2: + type: string + example: string + additionalProp3: + type: string + example: string + match_re: + type: object + properties: + additionalProp1: + type: object + properties: + additionalProp2: + type: object + properties: + additionalProp3: + type: object + properties: + matchers: + type: array + items: + type: object + properties: + Name: + type: string + example: string + Type: + type: integer + format: int32 + example: 0 + Value: + type: string + example: string + mute_time_intervals: + type: array + items: + type: string + example: string + object_matchers: + type: array + items: + type: object + properties: + Name: + type: string + example: string + Type: + type: integer + format: int32 + example: 0 + Value: + type: string + example: string + provenance: + type: string + example: string + receiver: + type: string + example: string + repeat_interval: + type: string + example: string + routes: + type: array + items: + type: string + example: string + + put: + operationId: RouteGetPolicyTree + summary: Get the notification policy tree + description: >- + Get the notification policy tree. + tags: + - Grafana contact points + parameters: + - in: body + name: body + schema: + type: object + properties: + continue: + type: boolean + group_by: + type: array + items: + type: string + example: string + group_interval: + type: string + example: string + group_wait: + type: string + example: string + match: + type: object + properties: + additionalProp1: + type: string + example: string + additionalProp2: + type: string + example: string + additionalProp3: + type: string + example: string + match_re: + type: object + properties: + additionalProp1: + type: object + properties: + additionalProp2: + type: object + properties: + additionalProp3: + type: object + properties: + matchers: + type: array + items: + type: object + properties: + Name: + type: string + example: string + Type: + type: integer + format: int32 + example: 0 + Value: + type: string + example: string + mute_time_intervals: + type: array + items: + type: string + example: string + object_matchers: + type: array + items: + type: object + properties: + Name: + type: string + example: string + Type: + type: integer + format: int32 + example: 0 + Value: + type: string + example: string + provenance: + type: string + example: string + receiver: + type: string + example: string + repeat_interval: + type: string + example: string + routes: + type: array + items: + type: string + example: string + + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + 400: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Validator error. + + + + v1/grafana/api/datasources/summary: + get: + operationId: getAllDatasources + summary: Return a list of data sources + description: >- + Return a list of data sources for all accounts under the API token provided. + tags: + - Grafana data source + responses: + 200: + description: successful query + schema: + type: array + items: + type: object + properties: + id: + type: integer + example: 123 + description: Data source Id + uid: + type: string + example: DCFaFyDnk + description: Data source UID + name: + type: string + example: cluster6_metrics + description: Data source name + type: + type: string + example: prometheus + description: Enum for the data source type. Can be eithern prometheus or elasticsearch. + database: + type: string + example: 123456 + description: Metrics account ID + + 404: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Data source not found. + + v1/grafana/api/datasources/name/{metric_account_name}/summary: + get: + operationId: getDatasourceByAccount + summary: Get a data source for a given account + description: >- + Get a data source for a given account. + tags: + - Grafana data source + parameters: + + - in: path + name: metric_account_name + type: string + schema: + description: >- + Logz.io metric account name + responses: + 200: + description: successful query + schema: + type: object + properties: + id: + type: integer + example: 123 + description: Data source Id + uid: + type: string + example: DCFaFyDnk + description: Data source UID + name: + type: string + example: cluster6_metrics + description: Data source name + type: + type: string + example: prometheus + description: Enum for the data source type. Can be eithern prometheus or elasticsearch. + database: + type: string + example: 123456 + description: Metrics account ID + + 404: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Data source not found. + + + /v1/grafana/api/v1/provisioning/alert-rules: + get: + operationId: getAlertRules + summary: Return a list of all alerts + description: >- + Returns a list of all alerts. + tags: + - Grafana alerting provisioning + parameters: + + - in: query + name: panelId + type: integer + schema: + description: >- + Id of a specific panel to return in results. + - in: query + name: dashboardUid + type: integer + schema: + description: >- + Id of a specific dashboard to return in results. + + responses: + 200: + description: successful query + schema: + type: object + properties: + annotations: + type: object + description: Annotations for the dashboard + properties: + runbook_url: + type: string + description: URL to the runbook + example: https://supercoolrunbook.com/page/13 + condition: + type: string + description: Condition + example: A + data: + type: array + description: Response wrapper for the data retrieved + items: + type: object + description: Data items retrieved + properties: + datasourceUid: + type: string + description: Grafana data source unique identifier + example: -100 + model: + type: object + description: JSON is the raw JSON query and includes the model properties as well as custom properties. + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + description: Optional identifier for the type of query + example: + refId: + type: string + description: Unique identifier of the query, set by the frontend call. + example: A + relativeTimeRange: + type: object + description: Per query start and end time for requests + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + orgID: + type: integer + format: int32 + example: 0 + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + updated: + type: string + example: 2022-08-16T11:07:04.763Z + + post: + operationId: AlertRules + summary: Create a new alert rule + description: >- + Creates a new alert rule. + tags: + - Grafana alerting provisioning + parameters: + - in: body + name: body + schema: + type: object + properties: + annotations: + type: object + properties: + runbook_url: + type: string + example: https://supercoolrunbook.com/page/13 + condition: + type: string + example: A + data: + type: array + items: + type: object + required: + - datasourceUid + properties: + datasourceUid: + type: string + example: -100 + model: + type: object + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + example: + refId: + type: string + example: A + relativeTimeRange: + type: object + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + + responses: + 200: + description: successful query + schema: + type: object + properties: + annotations: + type: object + properties: + runbook_url: + type: string + example: https://supercoolrunbook.com/page/13 + condition: + type: string + example: A + data: + type: array + items: + type: object + properties: + datasourceUid: + type: string + example: -100 + model: + type: object + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + example: + refId: + type: string + example: A + relativeTimeRange: + type: object + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + orgID: + type: integer + format: int32 + example: 0 + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + updated: + type: string + example: 2022-08-16T13:09:06.350Z + + + + + /v1/grafana/api/v1/provisioning/alert-rules/{UID}: + get: + operationId: getAlertRulesByUID + summary: Return a list of all alerts by UID + description: >- + Returns a list of all alerts by a UID. + tags: + - Grafana alerting provisioning + parameters: + + - in: path + name: UID + type: string + schema: + description: >- + Alert rule UID. + + responses: + 200: + description: successful query + schema: + type: object + properties: + annotations: + type: object + properties: + runbook_url: + type: string + example: https://supercoolrunbook.com/page/13 + condition: + type: string + example: A + data: + type: array + items: + type: object + properties: + datasourceUid: + type: string + example: -100 + model: + type: object + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + example: + refId: + type: string + example: A + relativeTimeRange: + type: object + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + orgID: + type: integer + format: int32 + example: 0 + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + updated: + type: string + example: 2022-08-16T13:09:06.350Z + + put: + operationId: putAlertRulesByUID + summary: Amend an alert by UID + description: >- + Amend an alert by UID. + tags: + - Grafana alerting provisioning + parameters: + + - in: path + name: UID + type: string + schema: + description: >- + Alert rule UID. + - in: body + name: body + schema: + type: object + properties: + annotations: + type: object + properties: + runbook_url: + type: string + example: https://supercoolrunbook.com/page/13 + condition: + type: string + example: A + data: + type: array + items: + type: object + properties: + datasourceUid: + type: string + example: -100 + model: + type: object + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + example: + refId: + type: string + example: A + relativeTimeRange: + type: object + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + orgID: + type: integer + format: int32 + example: 0 + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + + responses: + 200: + description: successful query + schema: + type: object + properties: + annotations: + type: object + properties: + runbook_url: + type: string + example: https://supercoolrunbook.com/page/13 + condition: + type: string + example: A + data: + type: array + items: + type: object + properties: + datasourceUid: + type: string + example: -100 + model: + type: object + properties: + conditions: + type: array + items: + type: object + properties: + evaluator: + type: object + properties: + params: + type: array + items: + type: integer + format: int32 + example: 0 + type: + type: string + example: gt + operator: + type: object + properties: + type: + type: string + example: and + query: + type: object + properties: + params: + type: array + items: + reducer: + type: object + properties: + params: + type: array + items: + type: + type: string + example: avg + type: + type: string + example: query + datasource: + type: object + properties: + type: + type: string + example: __expr__ + uid: + type: string + example: __expr__ + expression: + type: string + example: 1 == 1 + hide: + type: boolean + intervalMs: + type: integer + format: int32 + example: 1000 + maxDataPoints: + type: integer + format: int32 + example: 43200 + refId: + type: string + example: A + type: + type: string + example: math + queryType: + type: string + example: + refId: + type: string + example: A + relativeTimeRange: + type: object + properties: + from: + type: integer + format: int32 + example: 0 + to: + type: integer + format: int32 + example: 0 + execErrState: + type: string + example: Alerting + folderUID: + type: string + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. + example: project_x + for: + type: integer + format: int32 + example: 0 + id: + type: integer + format: int32 + example: 0 + labels: + type: object + properties: + team: + type: string + example: sre-team-1 + noDataState: + type: string + example: Alerting + orgID: + type: integer + format: int32 + example: 0 + provenance: + type: string + example: string + ruleGroup: + type: string + example: eval_group_1 + title: + type: string + example: Always firing + uid: + type: string + example: string + updated: + type: string + example: 2022-08-16T14:04:25.062Z + + delete: + operationId: deleteAlertRulesByUID + summary: Delete alert rule by UID + description: >- + Deletes the annotation that matches the specified id. + tags: + - Grafana annotations + parameters: + - in: path + name: UID + type: string + schema: + description: >- + Alert rule UID. + + + responses: + 200: + description: successful query + schema: + type: object + properties: + message: + type: string + description: Confirmation message. + example: Annotation deleted + + + + + /v1/grafana/api/annotations/: get: @@ -1067,7 +2625,7 @@ paths: example: 1 folderUid: type: string - description: The UID of the folder to save the dashboard in. Overrides the folderId. + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. example: l3KqBxCMz message: type: string @@ -1240,7 +2798,7 @@ paths: folderUid: type: string example: l3KqBxCMz - description: Dashboard folder Uid. + description: The unique identifier (uid) of a folder to search in for dashboards. You cannot use `General` folder or the folder generated by logz.io - `Logz.io Dashboards` - to place your alerts. slug: type: string example: production-overview @@ -9969,12 +11527,8 @@ definitions: properties: accountName: type: string - description: Name of the restored account. + description: Name of the restored account example: My account name - username: - type: string - description: Owner of the restored account. Effectively, the user's email address. - example: user@organization.com startTime: type: integer format: int64 @@ -9985,33 +11539,6 @@ definitions: format: int64 description: UNIX timestamp in milliseconds specifying the latest logs to be restored. example: 1589954400.000000000 - filters: - type: array - items: - type: object - properties: - operatorType: - type: string - enum: - - IS - - IS_NOT - - ONE_OF - - NOT_ONE_OF - - EXISTS - - NOT_EXISTS - description: Enum value of the operator used to define the filter. - example: IS - fieldName: - type: string - description: Name of the field to filter on. - example: type - fieldValues: - type: array - description: Values of the field to filter on. - items: - type: object - properties: - RestoreRequest: type: object From 3c4706c8e16ab57f0e330b93cd7bb97b72dbbaee Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 15:34:36 +0100 Subject: [PATCH 02/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index f00fb1189..8039c4092 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -324,11 +324,11 @@ paths: - Grafana contact points parameters: - in: query - name: name - type: string - schema: - description: >- - Name to filter by. + name: name + type: string + schema: + description: >- + Name to filter by. responses: 200: description: ContactPoints From 5be45841d4f183764b571ed094ffc06feb6f86ab Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 15:40:54 +0100 Subject: [PATCH 03/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 8039c4092..2cbb162da 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -334,26 +334,26 @@ paths: description: ContactPoints schema: type: array - items: - type: object - properties: - disableResolveMessage: - type: boolean - name: - type: string - example: webhook_1 - provenance: - type: string - example: string - settings: - type: object - properties: - type: - type: string - example: webhook - uid: - type: string - example: my_external_reference + items: + type: object + properties: + disableResolveMessage: + type: boolean + name: + type: string + example: webhook_1 + provenance: + type: string + example: string + settings: + type: object + properties: + type: + type: string + example: webhook + uid: + type: string + example: my_external_reference post: operationId: RoutePostContactpoints From 84c37b15c04e3db96757a55b900a307b7ec553d0 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 15:51:29 +0100 Subject: [PATCH 04/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 42 +++++++++++++++---------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 2cbb162da..e89660a73 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -420,27 +420,27 @@ paths: delete: operationId: RouteDeleteContactpoints summary: Delete a contact point - description: >- - Delete a contact point. - tags: - - Grafana contact points - parameters: - - in: path - name: UID - type: string - required: true - schema: - description: >- - Contact point unique identifier. - responses: - 204: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: The contact point was deleted successfully. + description: >- + Delete a contact point. + tags: + - Grafana contact points + parameters: + - in: path + name: UID + type: string + required: true + schema: + description: >- + Contact point unique identifier. + responses: + 204: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. put: operationId: RouteUpdateContactpoints summary: Update a contact point From 8501c2aa5c6096073f38b21403db2fea96e4f697 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 15:54:37 +0100 Subject: [PATCH 05/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index e89660a73..26fbf5154 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -444,19 +444,19 @@ paths: put: operationId: RouteUpdateContactpoints summary: Update a contact point - description: >- - Update a contact point. - tags: - - Grafana contact points - parameters: - - in: path - name: UID - type: string - required: true - schema: - description: >- - Contact point unique identifier. - - in: body + description: >- + Update a contact point. + tags: + - Grafana contact points + parameters: + - in: path + name: UID + type: string + required: true + schema: + description: >- + Contact point unique identifier. + - in: body name: body schema: type: object From 4bab6bf47a9f4c9202a6453fcf3053453d257bd3 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 16:00:11 +0100 Subject: [PATCH 06/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 44 +++++++++++++++---------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 26fbf5154..cfd244021 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -475,28 +475,28 @@ paths: uid: type: string example: my_external_reference - responses: - 202: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: The contact point was deleted successfully. - 204: - description: Acknowledged - schema: - type: object - properties: - 400: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: Validator error. + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + 204: + description: Acknowledged + schema: + type: object + properties: + 400: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Validator error. v1/provisioning/contact-points/{UID}: From e4cb50ae1ca5abbdff532be0aecb29e5f9937ea7 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 16:06:27 +0100 Subject: [PATCH 07/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 206 +++++++++++++++--------------- 1 file changed, 103 insertions(+), 103 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index cfd244021..03a3831bd 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -503,128 +503,128 @@ paths: delete: operationId: RouteResetPolicyTree summary: Clears the notification policy tree - description: >- - Clears the notification policy tree. - tags: - - Grafana contact points - responses: - 202: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: The contact point was deleted successfully. + description: >- + Clears the notification policy tree. + tags: + - Grafana contact points + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. get: operationId: RouteGetPolicyTree summary: Get the notification policy tree - description: >- - Get the notification policy tree. - tags: - - Grafana contact points - responses: - 202: - description: Not Found - schema: - type: object - properties: - continue: - type: boolean - group_by: - type: array - items: - type: string - example: string - group_interval: - type: string - example: string - group_wait: + description: >- + Get the notification policy tree. + tags: + - Grafana contact points + responses: + 202: + description: Not Found + schema: + type: object + properties: + continue: + type: boolean + group_by: + type: array + items: type: string example: string - match: + group_interval: + type: string + example: string + group_wait: + type: string + example: string + match: + type: object + properties: + additionalProp1: + type: string + example: string + additionalProp2: + type: string + example: string + additionalProp3: + type: string + example: string + match_re: + type: object + properties: + additionalProp1: + type: object + properties: + additionalProp2: + type: object + properties: + additionalProp3: + type: object + properties: + matchers: + type: array + items: type: object properties: - additionalProp1: - type: string - example: string - additionalProp2: + Name: type: string example: string - additionalProp3: + Type: + type: integer + format: int32 + example: 0 + Value: type: string example: string - match_re: - type: object - properties: - additionalProp1: - type: object - properties: - additionalProp2: - type: object - properties: - additionalProp3: - type: object - properties: - matchers: - type: array - items: - type: object - properties: - Name: - type: string - example: string - Type: - type: integer - format: int32 - example: 0 - Value: - type: string - example: string - mute_time_intervals: - type: array - items: - type: string - example: string - object_matchers: - type: array - items: - type: object - properties: - Name: - type: string - example: string - Type: - type: integer - format: int32 - example: 0 - Value: - type: string - example: string - provenance: - type: string - example: string - receiver: + mute_time_intervals: + type: array + items: type: string example: string - repeat_interval: + object_matchers: + type: array + items: + type: object + properties: + Name: + type: string + example: string + Type: + type: integer + format: int32 + example: 0 + Value: + type: string + example: string + provenance: + type: string + example: string + receiver: + type: string + example: string + repeat_interval: + type: string + example: string + routes: + type: array + items: type: string example: string - routes: - type: array - items: - type: string - example: string put: operationId: RouteGetPolicyTree summary: Get the notification policy tree - description: >- - Get the notification policy tree. - tags: - - Grafana contact points - parameters: - - in: body + description: >- + Get the notification policy tree. + tags: + - Grafana contact points + parameters: + - in: body name: body schema: type: object From 028ffc27e7609565fbaa78b44944e63b0213feba Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 16:09:40 +0100 Subject: [PATCH 08/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 34 +++++++++++++++---------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 03a3831bd..79f5d86d8 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -716,23 +716,23 @@ paths: type: string example: string - responses: - 202: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: The contact point was deleted successfully. - 400: - description: Not Found - schema: - type: object - properties: - message: - type: string - example: Validator error. + responses: + 202: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: The contact point was deleted successfully. + 400: + description: Not Found + schema: + type: object + properties: + message: + type: string + example: Validator error. From 8db6d2749137a3b8a1b687b0659c634c62e71993 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 16:45:53 +0100 Subject: [PATCH 09/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 79f5d86d8..83d9815f7 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -499,7 +499,7 @@ paths: example: Validator error. - v1/provisioning/contact-points/{UID}: + v1/provisioning/policies: delete: operationId: RouteResetPolicyTree summary: Clears the notification policy tree From 0e059bce0fc90dc31f0aa31b79dceff11aab204b Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 16:51:06 +0100 Subject: [PATCH 10/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 46 +++++++++++++++---------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 83d9815f7..57e67e5a5 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -749,29 +749,29 @@ paths: description: successful query schema: type: array - items: - type: object - properties: - id: - type: integer - example: 123 - description: Data source Id - uid: - type: string - example: DCFaFyDnk - description: Data source UID - name: - type: string - example: cluster6_metrics - description: Data source name - type: - type: string - example: prometheus - description: Enum for the data source type. Can be eithern prometheus or elasticsearch. - database: - type: string - example: 123456 - description: Metrics account ID + items: + type: object + properties: + id: + type: integer + example: 123 + description: Data source Id + uid: + type: string + example: DCFaFyDnk + description: Data source UID + name: + type: string + example: cluster6_metrics + description: Data source name + type: + type: string + example: prometheus + description: Enum for the data source type. Can be eithern prometheus or elasticsearch. + database: + type: string + example: 123456 + description: Metrics account ID 404: description: Not Found From 611fb17f7c275e6adec7ff73ca6488361c93cda6 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 17:17:38 +0100 Subject: [PATCH 11/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 52 ++++++++++++++++++++++--------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 57e67e5a5..a91da23fa 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -337,22 +337,28 @@ paths: items: type: object properties: - disableResolveMessage: + disableResolveMessage: + description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. type: boolean name: type: string + description: Contact point name. example: webhook_1 provenance: type: string + description: Provenance example: string settings: type: object + description: Contact point settings. properties: type: type: string + description: Contact point type. example: webhook uid: type: string + description: Unique identifier of the contact point. example: my_external_reference post: @@ -370,18 +376,23 @@ paths: properties: disableResolveMessage: type: boolean + description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. name: type: string + description: Contact point name. example: webhook_1 settings: type: object + description: Contact point settings. properties: type: type: string example: webhook + description: Contact point type. uid: type: string example: my_external_reference + description: Unique identifier of the contact point. responses: 202: description: ContactPoints @@ -389,22 +400,28 @@ paths: type: object properties: definitions: - disableResolveMessage: + disableResolveMessage: + description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. type: boolean name: type: string + description: Contact point name. example: webhook_1 provenance: type: string + description: Provenance example: string settings: type: object + description: Contact point settings. properties: type: type: string + description: Contact point type. example: webhook uid: type: string + description: Unique identifier of the contact point. example: my_external_reference 400: description: Not Found @@ -462,19 +479,24 @@ paths: type: object properties: disableResolveMessage: - type: boolean - name: - type: string - example: webhook_1 - settings: - type: object - properties: - type: - type: string - example: webhook - uid: - type: string - example: my_external_reference + description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. + type: boolean + name: + type: string + description: Contact point name. + example: webhook_1 + settings: + type: object + description: Contact point settings. + properties: + type: + type: string + description: Contact point type. + example: webhook + uid: + type: string + description: Unique identifier of the contact point. + example: my_external_reference responses: 202: description: Not Found From 15dffcc4e415a64c04e075e36f42f2eb0887d5b9 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 17:29:05 +0100 Subject: [PATCH 12/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 36 +++++++++++++++---------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index a91da23fa..7c022dbd7 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -479,24 +479,24 @@ paths: type: object properties: disableResolveMessage: - description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. - type: boolean - name: - type: string - description: Contact point name. - example: webhook_1 - settings: - type: object - description: Contact point settings. - properties: - type: - type: string - description: Contact point type. - example: webhook - uid: - type: string - description: Unique identifier of the contact point. - example: my_external_reference + description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. + type: boolean + name: + type: string + description: Contact point name. + example: webhook_1 + settings: + type: object + description: Contact point settings. + properties: + type: + type: string + description: Contact point type. + example: webhook + uid: + type: string + description: Unique identifier of the contact point. + example: my_external_reference responses: 202: description: Not Found From fbbd7191064a078f8e9e47a5f60e2f2a8285f0b2 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 17:41:37 +0100 Subject: [PATCH 13/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index 7c022dbd7..d598ec85f 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -338,27 +338,21 @@ paths: type: object properties: disableResolveMessage: - description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. type: boolean name: type: string - description: Contact point name. example: webhook_1 provenance: type: string - description: Provenance example: string settings: type: object - description: Contact point settings. properties: type: type: string - description: Contact point type. example: webhook uid: type: string - description: Unique identifier of the contact point. example: my_external_reference post: @@ -376,23 +370,18 @@ paths: properties: disableResolveMessage: type: boolean - description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. name: type: string - description: Contact point name. example: webhook_1 settings: type: object - description: Contact point settings. properties: type: type: string example: webhook - description: Contact point type. uid: type: string example: my_external_reference - description: Unique identifier of the contact point. responses: 202: description: ContactPoints @@ -405,23 +394,18 @@ paths: type: boolean name: type: string - description: Contact point name. example: webhook_1 provenance: type: string - description: Provenance example: string settings: type: object - description: Contact point settings. properties: type: type: string - description: Contact point type. example: webhook uid: type: string - description: Unique identifier of the contact point. example: my_external_reference 400: description: Not Found @@ -479,23 +463,18 @@ paths: type: object properties: disableResolveMessage: - description: When selected, this option disables the resolve message that is sent when the alerting state returns to false. type: boolean name: type: string - description: Contact point name. example: webhook_1 settings: type: object - description: Contact point settings. properties: type: type: string - description: Contact point type. example: webhook uid: type: string - description: Unique identifier of the contact point. example: my_external_reference responses: 202: From 3512037b8fdfb807fb584f8e934dee78ffc5b513 Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 17:47:12 +0100 Subject: [PATCH 14/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index d598ec85f..c110415c8 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -11563,3 +11563,4 @@ definitions: format: int64 description: ? example: + From 3da9fb3802245a84f93163334762c9c6a6eeacfa Mon Sep 17 00:00:00 2001 From: Nico <86240618+nico-shishkin@users.noreply.github.com> Date: Mon, 17 Oct 2022 17:55:50 +0100 Subject: [PATCH 15/15] Update logzio-public-api.yml --- _source/api/logzio-public-api.yml | 48 ------------------------------- 1 file changed, 48 deletions(-) diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml index c110415c8..4b737ff0d 100644 --- a/_source/api/logzio-public-api.yml +++ b/_source/api/logzio-public-api.yml @@ -341,19 +341,15 @@ paths: type: boolean name: type: string - example: webhook_1 provenance: type: string - example: string settings: type: object properties: type: type: string - example: webhook uid: type: string - example: my_external_reference post: operationId: RoutePostContactpoints @@ -372,16 +368,13 @@ paths: type: boolean name: type: string - example: webhook_1 settings: type: object properties: type: type: string - example: webhook uid: type: string - example: my_external_reference responses: 202: description: ContactPoints @@ -394,19 +387,15 @@ paths: type: boolean name: type: string - example: webhook_1 provenance: type: string - example: string settings: type: object properties: type: type: string - example: webhook uid: type: string - example: my_external_reference 400: description: Not Found schema: @@ -466,16 +455,13 @@ paths: type: boolean name: type: string - example: webhook_1 settings: type: object properties: type: type: string - example: webhook uid: type: string - example: my_external_reference responses: 202: description: Not Found @@ -536,25 +522,19 @@ paths: type: array items: type: string - example: string group_interval: type: string - example: string group_wait: type: string - example: string match: type: object properties: additionalProp1: type: string - example: string additionalProp2: type: string - example: string additionalProp3: type: string - example: string match_re: type: object properties: @@ -574,19 +554,15 @@ paths: properties: Name: type: string - example: string Type: type: integer format: int32 - example: 0 Value: type: string - example: string mute_time_intervals: type: array items: type: string - example: string object_matchers: type: array items: @@ -594,28 +570,21 @@ paths: properties: Name: type: string - example: string Type: type: integer format: int32 - example: 0 Value: type: string - example: string provenance: type: string - example: string receiver: type: string - example: string repeat_interval: type: string - example: string routes: type: array items: type: string - example: string put: operationId: RouteGetPolicyTree @@ -636,25 +605,19 @@ paths: type: array items: type: string - example: string group_interval: type: string - example: string group_wait: type: string - example: string match: type: object properties: additionalProp1: type: string - example: string additionalProp2: type: string - example: string additionalProp3: type: string - example: string match_re: type: object properties: @@ -674,19 +637,15 @@ paths: properties: Name: type: string - example: string Type: type: integer format: int32 - example: 0 Value: type: string - example: string mute_time_intervals: type: array items: type: string - example: string object_matchers: type: array items: @@ -694,28 +653,21 @@ paths: properties: Name: type: string - example: string Type: type: integer format: int32 - example: 0 Value: type: string - example: string provenance: type: string - example: string receiver: type: string - example: string repeat_interval: type: string - example: string routes: type: array items: type: string - example: string responses: 202: