Skip to content

Commit 0de9d5c

Browse files
committed
MW resource
1 parent 0d7feee commit 0de9d5c

19 files changed

+3206
-439
lines changed

generated/alerting/.openapi-generator/FILES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ docs/AlertResponseProperties.md
1616
docs/AlertResponsePropertiesExecutionStatus.md
1717
docs/AlertResponsePropertiesSchedule.md
1818
docs/AlertingAPI.md
19+
docs/CreateMaintenanceWindowRequest.md
1920
docs/CreateRuleRequest.md
2021
docs/FieldmapProperties.md
2122
docs/FieldmapPropertiesPropertiesValue.md
@@ -54,10 +55,13 @@ docs/LegacyGetAlertingHealth200ResponseAlertingFrameworkHealthReadHealth.md
5455
docs/LegacyUpdateAlertRequestProperties.md
5556
docs/LegacyUpdateAlertRequestPropertiesActionsInner.md
5657
docs/LegacyUpdateAlertRequestPropertiesSchedule.md
58+
docs/MaintenanceWindowResponseProperties.md
5759
docs/Model400Response.md
5860
docs/Model401Response.md
61+
docs/Model403Response.md
5962
docs/Model404Response.md
6063
docs/NotifyWhen.md
64+
docs/NotifyWhenAction.md
6165
docs/RuleResponseProperties.md
6266
docs/RuleResponsePropertiesExecutionStatus.md
6367
docs/RuleResponsePropertiesLastRun.md
@@ -69,6 +73,7 @@ go.mod
6973
go.sum
7074
model_400_response.go
7175
model_401_response.go
76+
model_403_response.go
7277
model_404_response.go
7378
model_actions_inner.go
7479
model_actions_inner_alerts_filter.go
@@ -80,6 +85,7 @@ model_alert_delay.go
8085
model_alert_response_properties.go
8186
model_alert_response_properties_execution_status.go
8287
model_alert_response_properties_schedule.go
88+
model_create_maintenance_window_request.go
8389
model_create_rule_request.go
8490
model_fieldmap_properties.go
8591
model_fieldmap_properties_properties_value.go
@@ -118,6 +124,7 @@ model_legacy_get_alerting_health_200_response_alerting_framework_health_read_hea
118124
model_legacy_update_alert_request_properties.go
119125
model_legacy_update_alert_request_properties_actions_inner.go
120126
model_legacy_update_alert_request_properties_schedule.go
127+
model_maintenance_window_response_properties.go
121128
model_notify_when.go
122129
model_notify_when_action.go
123130
model_rule_response_properties.go

generated/alerting/README.md

Lines changed: 114 additions & 102 deletions
Large diffs are not rendered by default.

generated/alerting/api/openapi.yaml

Lines changed: 214 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,6 +1065,106 @@ paths:
10651065
summary: Unmutes an alert instance.
10661066
tags:
10671067
- alerting
1068+
/api/alerting/maintenance_window:
1069+
post:
1070+
description: |
1071+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
1072+
operationId: createMaintenanceWindow
1073+
parameters:
1074+
- $ref: '#/components/parameters/kbn_xsrf'
1075+
requestBody:
1076+
content:
1077+
application/json:
1078+
schema:
1079+
$ref: '#/components/schemas/create_maintenance_window_request'
1080+
required: true
1081+
responses:
1082+
"200":
1083+
content:
1084+
application/json:
1085+
schema:
1086+
$ref: '#/components/schemas/maintenance_window_response_properties'
1087+
description: Indicates a successful call.
1088+
"400":
1089+
content:
1090+
application/json:
1091+
schema:
1092+
$ref: '#/components/schemas/400_response'
1093+
description: Indicates an invalid schema or parameters.
1094+
"403":
1095+
content:
1096+
application/json:
1097+
schema:
1098+
$ref: '#/components/schemas/403_response'
1099+
description: Indicates that this call is forbidden.
1100+
summary: Create a maintenance window with a random identifier
1101+
tags:
1102+
- alerting
1103+
/api/alerting/maintenance_window/{maintenanceWindowId}:
1104+
delete:
1105+
description: |
1106+
To delete a rule, you must have `all` privileges for the appropriate Kibana features. WARNING: After you delete a maintenance window, you cannot recover it.
1107+
operationId: deleteMaintenanceWindow
1108+
parameters:
1109+
- $ref: '#/components/parameters/kbn_xsrf'
1110+
- $ref: '#/components/parameters/maintenance_window_id'
1111+
responses:
1112+
"204":
1113+
description: Indicates a successful call.
1114+
"400":
1115+
content:
1116+
application/json:
1117+
schema:
1118+
$ref: '#/components/schemas/400_response'
1119+
description: Indicates an invalid schema or parameters.
1120+
"403":
1121+
content:
1122+
application/json:
1123+
schema:
1124+
$ref: '#/components/schemas/403_response'
1125+
description: Indicates that this call is forbidden.
1126+
"404":
1127+
content:
1128+
application/json:
1129+
schema:
1130+
$ref: '#/components/schemas/404_response'
1131+
description: Object is not found.
1132+
summary: Delete a maintenance window
1133+
tags:
1134+
- alerting
1135+
get:
1136+
description: You must have `read` privileges for the appropriate Kibana features.
1137+
operationId: getMaintenanceWindow
1138+
parameters:
1139+
- $ref: '#/components/parameters/maintenance_window_id'
1140+
responses:
1141+
"200":
1142+
content:
1143+
application/json:
1144+
schema:
1145+
$ref: '#/components/schemas/maintenance_window_response_properties'
1146+
description: Indicates a successful call.
1147+
"400":
1148+
content:
1149+
application/json:
1150+
schema:
1151+
$ref: '#/components/schemas/400_response'
1152+
description: Indicates an invalid schema or parameters.
1153+
"403":
1154+
content:
1155+
application/json:
1156+
schema:
1157+
$ref: '#/components/schemas/403_response'
1158+
description: Indicates that this call is forbidden.
1159+
"404":
1160+
content:
1161+
application/json:
1162+
schema:
1163+
$ref: '#/components/schemas/404_response'
1164+
description: Object is not found.
1165+
summary: Get maintenance window details
1166+
tags:
1167+
- alerting
10681168
components:
10691169
examples:
10701170
create_es_query_esql_rule_request:
@@ -2148,6 +2248,15 @@ components:
21482248
required: true
21492249
schema: {}
21502250
style: simple
2251+
maintenance_window_id:
2252+
description: An identifier for the maintenance window.
2253+
explode: false
2254+
in: path
2255+
name: maintenanceWindowId
2256+
required: true
2257+
schema:
2258+
example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
2259+
style: simple
21512260
schemas:
21522261
filter:
21532262
description: A filter written in Elasticsearch Query Domain Specific Language
@@ -2652,10 +2761,8 @@ components:
26522761
description: Indicates whether the field is required.
26532762
type: boolean
26542763
scaling_factor:
2655-
description: "The scaling factor to use when encoding values. This property\
2656-
\ is applicable when `type` is `scaled_float`. Values will be multiplied\
2657-
\ by this factor at index time and rounded to the closest long value.\
2658-
\ \n"
2764+
description: |
2765+
The scaling factor to use when encoding values. This property is applicable when `type` is `scaled_float`. Values will be multiplied by this factor at index time and rounded to the closest long value.
26592766
type: integer
26602767
type:
26612768
description: Specifies the data type for the field.
@@ -2767,6 +2874,109 @@ components:
27672874
nullable: true
27682875
type: string
27692876
title: Legacy alert response properties
2877+
create_maintenance_window_request:
2878+
description: The properties used to create a maintenance window.
2879+
properties:
2880+
title:
2881+
description: |
2882+
The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a maintenance window.
2883+
type: string
2884+
enabled:
2885+
description: Indicates whether the maintenance window is currently enabled.
2886+
example: true
2887+
type: boolean
2888+
duration:
2889+
type: number
2890+
start:
2891+
description: An ISO date.
2892+
type: string
2893+
required:
2894+
- duration
2895+
- start
2896+
- title
2897+
title: Create maintenance window request body properties
2898+
maintenance_window_response_properties:
2899+
example:
2900+
duration: 0.8008281904610115
2901+
updated_at: 2022-12-05T23:36:58.284Z
2902+
start: start
2903+
updated_by: elastic
2904+
created_at: 2022-12-05T23:36:58.284Z
2905+
id: b530fed0-74f5-11ed-9801-35303b735aef
2906+
title: ESQuery Maintenance Window
2907+
created_by: elastic
2908+
enabled: true
2909+
status: running
2910+
properties:
2911+
id:
2912+
description: The identifier for the maintenance window.
2913+
example: b530fed0-74f5-11ed-9801-35303b735aef
2914+
type: string
2915+
title:
2916+
description: The name of the maintenance window.
2917+
example: ESQuery Maintenance Window
2918+
type: string
2919+
start:
2920+
description: The start date of the maintenance window.
2921+
type: string
2922+
duration:
2923+
description: The duration of the maintenance window.
2924+
type: number
2925+
enabled:
2926+
description: Indicates whether the maintenance window is currently enabled.
2927+
example: true
2928+
type: boolean
2929+
created_by:
2930+
description: The identifier for the user that created the maintenance window.
2931+
example: elastic
2932+
type: string
2933+
nullable: true
2934+
created_at:
2935+
description: The date and time in which the maintenance window was created.
2936+
example: 2022-12-05T23:36:58.284Z
2937+
format: date-time
2938+
type: string
2939+
updated_by:
2940+
description: The identifier for the user that updated this maintenance window
2941+
most recently.
2942+
example: elastic
2943+
type: string
2944+
nullable: true
2945+
updated_at:
2946+
description: The date and time that the maintenance window was updated most
2947+
recently.
2948+
example: 2022-12-05T23:36:58.284Z
2949+
type: string
2950+
status:
2951+
description: "The status of the maintenance window. One of the following\
2952+
\ values `running`, `upcoming`, `finished` or `archived`."
2953+
example: running
2954+
type: string
2955+
required:
2956+
- created_at
2957+
- created_by
2958+
- duration
2959+
- enabled
2960+
- id
2961+
- start
2962+
- status
2963+
- title
2964+
- updated_at
2965+
- updated_by
2966+
title: Maintenance window response properties
2967+
"403_response":
2968+
properties:
2969+
statusCode:
2970+
description: Error status code
2971+
example: 403
2972+
type: number
2973+
error:
2974+
description: Error type
2975+
example: Forbidden
2976+
type: string
2977+
message:
2978+
description: Error message
2979+
type: string
27702980
findRules_has_reference_parameter:
27712981
properties:
27722982
id:

0 commit comments

Comments
 (0)