Skip to content

Commit 0075abe

Browse files
julienduchesnejulienduchesne
authored
OpenAPI: Fix ProvisionedAlertRule.for type (grafana#90841)
This override has been in the client for a while now: https://github.com/grafana/grafana-openapi-client-go/blob/9ef69836127d783a63b2d0c61b2f8bf3de0c8e86/scripts/pull-schema.sh#L34-L39 The API expects a string here and transforms it to a duration internally
1 parent 1373b37 commit 0075abe

File tree

6 files changed

+15
-16
lines changed

6 files changed

+15
-16
lines changed

‎pkg/services/ngalert/api/tooling/api.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2960,7 +2960,8 @@
29602960
"type": "string"
29612961
},
29622962
"for": {
2963-
"$ref": "#/definitions/Duration"
2963+
"format": "duration",
2964+
"type": "string"
29642965
},
29652966
"id": {
29662967
"format": "int64",
@@ -4316,6 +4317,7 @@
43164317
"type": "object"
43174318
},
43184319
"URL": {
4320+
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nThe Host field contains the host and port subcomponents of the URL.\nWhen the port is present, it is separated from the host with a colon.\nWhen the host is an IPv6 address, it must be enclosed in square brackets:\n\"[fe80::1]:80\". The [net.JoinHostPort] function combines a host and port\ninto a string suitable for the Host field, adding square brackets to\nthe host when necessary.\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use the [URL.EscapedPath] method, which preserves\nthe original encoding of Path.\n\nThe RawPath field is an optional field which is only set when the default\nencoding of Path is different from the escaped path. See the EscapedPath method\nfor more details.\n\nURL's String method uses the EscapedPath method to obtain the path.",
43194321
"properties": {
43204322
"ForceQuery": {
43214323
"type": "boolean"
@@ -4351,7 +4353,7 @@
43514353
"$ref": "#/definitions/Userinfo"
43524354
}
43534355
},
4354-
"title": "URL is a custom URL type that allows validation at configuration load time.",
4356+
"title": "A URL represents a parsed URL (technically, a URI reference).",
43554357
"type": "object"
43564358
},
43574359
"UpdateRuleGroupResponse": {
@@ -4743,7 +4745,6 @@
47434745
"type": "object"
47444746
},
47454747
"gettableAlerts": {
4746-
"description": "GettableAlerts gettable alerts",
47474748
"items": {
47484749
"$ref": "#/definitions/gettableAlert",
47494750
"type": "object"
@@ -4868,7 +4869,6 @@
48684869
"type": "object"
48694870
},
48704871
"gettableSilences": {
4871-
"description": "GettableSilences gettable silences",
48724872
"items": {
48734873
"$ref": "#/definitions/gettableSilence",
48744874
"type": "object"

‎pkg/services/ngalert/api/tooling/definitions/provisioning_alert_rules.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ type ProvisionedAlertRule struct {
156156
// required: true
157157
ExecErrState ExecutionErrorState `json:"execErrState"`
158158
// required: true
159+
// swagger:strfmt duration
159160
For model.Duration `json:"for"`
160161
// example: {"runbook_url": "https://supercoolrunbook.com/page/13"}
161162
Annotations map[string]string `json:"annotations,omitempty"`

‎pkg/services/ngalert/api/tooling/post.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2960,7 +2960,8 @@
29602960
"type": "string"
29612961
},
29622962
"for": {
2963-
"$ref": "#/definitions/Duration"
2963+
"format": "duration",
2964+
"type": "string"
29642965
},
29652966
"id": {
29662967
"format": "int64",
@@ -4316,7 +4317,6 @@
43164317
"type": "object"
43174318
},
43184319
"URL": {
4319-
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nThe Host field contains the host and port subcomponents of the URL.\nWhen the port is present, it is separated from the host with a colon.\nWhen the host is an IPv6 address, it must be enclosed in square brackets:\n\"[fe80::1]:80\". The [net.JoinHostPort] function combines a host and port\ninto a string suitable for the Host field, adding square brackets to\nthe host when necessary.\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use the [URL.EscapedPath] method, which preserves\nthe original encoding of Path.\n\nThe RawPath field is an optional field which is only set when the default\nencoding of Path is different from the escaped path. See the EscapedPath method\nfor more details.\n\nURL's String method uses the EscapedPath method to obtain the path.",
43204320
"properties": {
43214321
"ForceQuery": {
43224322
"type": "boolean"
@@ -4352,7 +4352,7 @@
43524352
"$ref": "#/definitions/Userinfo"
43534353
}
43544354
},
4355-
"title": "A URL represents a parsed URL (technically, a URI reference).",
4355+
"title": "URL is a custom URL type that allows validation at configuration load time.",
43564356
"type": "object"
43574357
},
43584358
"UpdateRuleGroupResponse": {

‎pkg/services/ngalert/api/tooling/spec.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6605,7 +6605,8 @@
66056605
"example": "project_x"
66066606
},
66076607
"for": {
6608-
"$ref": "#/definitions/Duration"
6608+
"type": "string",
6609+
"format": "duration"
66096610
},
66106611
"id": {
66116612
"type": "integer",
@@ -7949,9 +7950,8 @@
79497950
}
79507951
},
79517952
"URL": {
7952-
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nThe Host field contains the host and port subcomponents of the URL.\nWhen the port is present, it is separated from the host with a colon.\nWhen the host is an IPv6 address, it must be enclosed in square brackets:\n\"[fe80::1]:80\". The [net.JoinHostPort] function combines a host and port\ninto a string suitable for the Host field, adding square brackets to\nthe host when necessary.\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use the [URL.EscapedPath] method, which preserves\nthe original encoding of Path.\n\nThe RawPath field is an optional field which is only set when the default\nencoding of Path is different from the escaped path. See the EscapedPath method\nfor more details.\n\nURL's String method uses the EscapedPath method to obtain the path.",
79537953
"type": "object",
7954-
"title": "A URL represents a parsed URL (technically, a URI reference).",
7954+
"title": "URL is a custom URL type that allows validation at configuration load time.",
79557955
"properties": {
79567956
"ForceQuery": {
79577957
"type": "boolean"

‎public/api-merged.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18432,7 +18432,8 @@
1843218432
"example": "project_x"
1843318433
},
1843418434
"for": {
18435-
"$ref": "#/definitions/Duration"
18435+
"type": "string",
18436+
"format": "duration"
1843618437
},
1843718438
"id": {
1843818439
"type": "integer",
@@ -22360,7 +22361,6 @@
2236022361
}
2236122362
},
2236222363
"gettableAlerts": {
22363-
"description": "GettableAlerts gettable alerts",
2236422364
"type": "array",
2236522365
"items": {
2236622366
"type": "object",
@@ -22485,7 +22485,6 @@
2248522485
}
2248622486
},
2248722487
"gettableSilences": {
22488-
"description": "GettableSilences gettable silences",
2248922488
"type": "array",
2249022489
"items": {
2249122490
"type": "object",

‎public/openapi3.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8480,7 +8480,8 @@
84808480
"type": "string"
84818481
},
84828482
"for": {
8483-
"$ref": "#/components/schemas/Duration"
8483+
"format": "duration",
8484+
"type": "string"
84848485
},
84858486
"id": {
84868487
"format": "int64",
@@ -12418,7 +12419,6 @@
1241812419
"type": "object"
1241912420
},
1242012421
"gettableAlerts": {
12421-
"description": "GettableAlerts gettable alerts",
1242212422
"items": {
1242312423
"$ref": "#/components/schemas/gettableAlert"
1242412424
},
@@ -12542,7 +12542,6 @@
1254212542
"type": "object"
1254312543
},
1254412544
"gettableSilences": {
12545-
"description": "GettableSilences gettable silences",
1254612545
"items": {
1254712546
"$ref": "#/components/schemas/gettableSilence"
1254812547
},

0 commit comments

Comments
 (0)