@grafana/openapi 13.1.0-27729613434 → 13.1.0-27923201854
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api/openapi3.json
CHANGED
|
@@ -15262,6 +15262,14 @@
|
|
|
15262
15262
|
"type": "integer"
|
|
15263
15263
|
}
|
|
15264
15264
|
},
|
|
15265
|
+
{
|
|
15266
|
+
"description": "Limit response to annotations created by a specific user, identified by UID.",
|
|
15267
|
+
"in": "query",
|
|
15268
|
+
"name": "userUID",
|
|
15269
|
+
"schema": {
|
|
15270
|
+
"type": "string"
|
|
15271
|
+
}
|
|
15272
|
+
},
|
|
15265
15273
|
{
|
|
15266
15274
|
"description": "Find annotations for a specified alert rule by its ID.\ndeprecated: AlertID is deprecated and will be removed in future versions. Please use AlertUID instead.",
|
|
15267
15275
|
"in": "query",
|
|
@@ -5630,6 +5630,23 @@
|
|
|
5630
5630
|
}
|
|
5631
5631
|
]
|
|
5632
5632
|
},
|
|
5633
|
+
"UserExternalAuthInfo": {
|
|
5634
|
+
"type": "object",
|
|
5635
|
+
"required": ["module", "authID"],
|
|
5636
|
+
"properties": {
|
|
5637
|
+
"authID": {
|
|
5638
|
+
"type": "string",
|
|
5639
|
+
"default": ""
|
|
5640
|
+
},
|
|
5641
|
+
"externalUID": {
|
|
5642
|
+
"type": "string"
|
|
5643
|
+
},
|
|
5644
|
+
"module": {
|
|
5645
|
+
"type": "string",
|
|
5646
|
+
"default": ""
|
|
5647
|
+
}
|
|
5648
|
+
}
|
|
5649
|
+
},
|
|
5633
5650
|
"UserList": {
|
|
5634
5651
|
"type": "object",
|
|
5635
5652
|
"required": ["metadata", "items"],
|
|
@@ -5686,6 +5703,17 @@
|
|
|
5686
5703
|
"type": "boolean",
|
|
5687
5704
|
"default": false
|
|
5688
5705
|
},
|
|
5706
|
+
"externalAuthInfo": {
|
|
5707
|
+
"type": "array",
|
|
5708
|
+
"items": {
|
|
5709
|
+
"default": {},
|
|
5710
|
+
"allOf": [
|
|
5711
|
+
{
|
|
5712
|
+
"$ref": "#/components/schemas/UserExternalAuthInfo"
|
|
5713
|
+
}
|
|
5714
|
+
]
|
|
5715
|
+
}
|
|
5716
|
+
},
|
|
5689
5717
|
"grafanaAdmin": {
|
|
5690
5718
|
"type": "boolean",
|
|
5691
5719
|
"default": false
|
|
@@ -28,6 +28,953 @@
|
|
|
28
28
|
}
|
|
29
29
|
}
|
|
30
30
|
},
|
|
31
|
+
"/configs": {
|
|
32
|
+
"get": {
|
|
33
|
+
"tags": ["Config"],
|
|
34
|
+
"description": "list or watch objects of kind Config",
|
|
35
|
+
"operationId": "listConfig",
|
|
36
|
+
"parameters": [
|
|
37
|
+
{
|
|
38
|
+
"name": "continue",
|
|
39
|
+
"in": "query",
|
|
40
|
+
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
|
|
41
|
+
"schema": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"uniqueItems": true
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "fieldSelector",
|
|
48
|
+
"in": "query",
|
|
49
|
+
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
|
|
50
|
+
"schema": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"uniqueItems": true
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "labelSelector",
|
|
57
|
+
"in": "query",
|
|
58
|
+
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
|
|
59
|
+
"schema": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"uniqueItems": true
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "limit",
|
|
66
|
+
"in": "query",
|
|
67
|
+
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
|
|
68
|
+
"schema": {
|
|
69
|
+
"type": "integer",
|
|
70
|
+
"uniqueItems": true
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "resourceVersion",
|
|
75
|
+
"in": "query",
|
|
76
|
+
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
77
|
+
"schema": {
|
|
78
|
+
"type": "string",
|
|
79
|
+
"uniqueItems": true
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "timeoutSeconds",
|
|
84
|
+
"in": "query",
|
|
85
|
+
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
|
|
86
|
+
"schema": {
|
|
87
|
+
"type": "integer",
|
|
88
|
+
"uniqueItems": true
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "watch",
|
|
93
|
+
"in": "query",
|
|
94
|
+
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
|
|
95
|
+
"schema": {
|
|
96
|
+
"type": "boolean",
|
|
97
|
+
"uniqueItems": true
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
"responses": {
|
|
102
|
+
"200": {
|
|
103
|
+
"description": "OK",
|
|
104
|
+
"content": {
|
|
105
|
+
"application/json": {
|
|
106
|
+
"schema": {
|
|
107
|
+
"$ref": "#/components/schemas/ConfigList"
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"application/json;stream=watch": {
|
|
111
|
+
"schema": {
|
|
112
|
+
"$ref": "#/components/schemas/ConfigList"
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"application/yaml": {
|
|
116
|
+
"schema": {
|
|
117
|
+
"$ref": "#/components/schemas/ConfigList"
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"x-kubernetes-action": "list",
|
|
124
|
+
"x-kubernetes-group-version-kind": {
|
|
125
|
+
"group": "notifications.alerting.grafana.app",
|
|
126
|
+
"version": "v0alpha1",
|
|
127
|
+
"kind": "Config"
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"post": {
|
|
131
|
+
"tags": ["Config"],
|
|
132
|
+
"description": "create a Config",
|
|
133
|
+
"operationId": "createConfig",
|
|
134
|
+
"parameters": [
|
|
135
|
+
{
|
|
136
|
+
"name": "dryRun",
|
|
137
|
+
"in": "query",
|
|
138
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
139
|
+
"schema": {
|
|
140
|
+
"type": "string",
|
|
141
|
+
"uniqueItems": true
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "fieldManager",
|
|
146
|
+
"in": "query",
|
|
147
|
+
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
148
|
+
"schema": {
|
|
149
|
+
"type": "string",
|
|
150
|
+
"uniqueItems": true
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"name": "fieldValidation",
|
|
155
|
+
"in": "query",
|
|
156
|
+
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
157
|
+
"schema": {
|
|
158
|
+
"type": "string",
|
|
159
|
+
"uniqueItems": true
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
],
|
|
163
|
+
"requestBody": {
|
|
164
|
+
"content": {
|
|
165
|
+
"application/json": {
|
|
166
|
+
"schema": {
|
|
167
|
+
"$ref": "#/components/schemas/Config"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"application/yaml": {
|
|
171
|
+
"schema": {
|
|
172
|
+
"$ref": "#/components/schemas/Config"
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
"required": true
|
|
177
|
+
},
|
|
178
|
+
"responses": {
|
|
179
|
+
"200": {
|
|
180
|
+
"description": "OK",
|
|
181
|
+
"content": {
|
|
182
|
+
"application/json": {
|
|
183
|
+
"schema": {
|
|
184
|
+
"$ref": "#/components/schemas/Config"
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"application/yaml": {
|
|
188
|
+
"schema": {
|
|
189
|
+
"$ref": "#/components/schemas/Config"
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"201": {
|
|
195
|
+
"description": "Created",
|
|
196
|
+
"content": {
|
|
197
|
+
"application/json": {
|
|
198
|
+
"schema": {
|
|
199
|
+
"$ref": "#/components/schemas/Config"
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"application/yaml": {
|
|
203
|
+
"schema": {
|
|
204
|
+
"$ref": "#/components/schemas/Config"
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
"202": {
|
|
210
|
+
"description": "Accepted",
|
|
211
|
+
"content": {
|
|
212
|
+
"application/json": {
|
|
213
|
+
"schema": {
|
|
214
|
+
"$ref": "#/components/schemas/Config"
|
|
215
|
+
}
|
|
216
|
+
},
|
|
217
|
+
"application/yaml": {
|
|
218
|
+
"schema": {
|
|
219
|
+
"$ref": "#/components/schemas/Config"
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
},
|
|
225
|
+
"x-kubernetes-action": "post",
|
|
226
|
+
"x-kubernetes-group-version-kind": {
|
|
227
|
+
"group": "notifications.alerting.grafana.app",
|
|
228
|
+
"version": "v0alpha1",
|
|
229
|
+
"kind": "Config"
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
"delete": {
|
|
233
|
+
"tags": ["Config"],
|
|
234
|
+
"description": "delete collection of Config",
|
|
235
|
+
"operationId": "deletecollectionConfig",
|
|
236
|
+
"parameters": [
|
|
237
|
+
{
|
|
238
|
+
"name": "continue",
|
|
239
|
+
"in": "query",
|
|
240
|
+
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
|
|
241
|
+
"schema": {
|
|
242
|
+
"type": "string",
|
|
243
|
+
"uniqueItems": true
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "dryRun",
|
|
248
|
+
"in": "query",
|
|
249
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
250
|
+
"schema": {
|
|
251
|
+
"type": "string",
|
|
252
|
+
"uniqueItems": true
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "fieldSelector",
|
|
257
|
+
"in": "query",
|
|
258
|
+
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
|
|
259
|
+
"schema": {
|
|
260
|
+
"type": "string",
|
|
261
|
+
"uniqueItems": true
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "gracePeriodSeconds",
|
|
266
|
+
"in": "query",
|
|
267
|
+
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
|
|
268
|
+
"schema": {
|
|
269
|
+
"type": "integer",
|
|
270
|
+
"uniqueItems": true
|
|
271
|
+
}
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"name": "ignoreStoreReadErrorWithClusterBreakingPotential",
|
|
275
|
+
"in": "query",
|
|
276
|
+
"description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
|
|
277
|
+
"schema": {
|
|
278
|
+
"type": "boolean",
|
|
279
|
+
"uniqueItems": true
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"name": "labelSelector",
|
|
284
|
+
"in": "query",
|
|
285
|
+
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
|
|
286
|
+
"schema": {
|
|
287
|
+
"type": "string",
|
|
288
|
+
"uniqueItems": true
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "limit",
|
|
293
|
+
"in": "query",
|
|
294
|
+
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
|
|
295
|
+
"schema": {
|
|
296
|
+
"type": "integer",
|
|
297
|
+
"uniqueItems": true
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
"name": "orphanDependents",
|
|
302
|
+
"in": "query",
|
|
303
|
+
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
|
|
304
|
+
"schema": {
|
|
305
|
+
"type": "boolean",
|
|
306
|
+
"uniqueItems": true
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"name": "propagationPolicy",
|
|
311
|
+
"in": "query",
|
|
312
|
+
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
|
|
313
|
+
"schema": {
|
|
314
|
+
"type": "string",
|
|
315
|
+
"uniqueItems": true
|
|
316
|
+
}
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "resourceVersion",
|
|
320
|
+
"in": "query",
|
|
321
|
+
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
322
|
+
"schema": {
|
|
323
|
+
"type": "string",
|
|
324
|
+
"uniqueItems": true
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "resourceVersionMatch",
|
|
329
|
+
"in": "query",
|
|
330
|
+
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
331
|
+
"schema": {
|
|
332
|
+
"type": "string",
|
|
333
|
+
"uniqueItems": true
|
|
334
|
+
}
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "sendInitialEvents",
|
|
338
|
+
"in": "query",
|
|
339
|
+
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
|
|
340
|
+
"schema": {
|
|
341
|
+
"type": "boolean",
|
|
342
|
+
"uniqueItems": true
|
|
343
|
+
}
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"name": "shardSelector",
|
|
347
|
+
"in": "query",
|
|
348
|
+
"description": "shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges:\n\n shardRange(object.metadata.uid, '0x0', '0x8000000000000000')\n shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')\n\nField paths use CEL-style object-rooted syntax (e.g. \"object.metadata.uid\"), NOT the fieldSelector format (\"metadata.uid\"). Currently supported paths:\n - object.metadata.uid\n - object.metadata.namespace\n\nhexStart and hexEnd are single-quoted CEL string literals with a '0x' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64.\n\nExamples:\n 2-shard split:\n shard 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')\n shard 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')\n 4-shard split:\n shard 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')\n shard 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')\n shard 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')\n shard 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')\n\nThis is an alpha field and requires enabling the ShardedListAndWatch feature gate.",
|
|
349
|
+
"schema": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"uniqueItems": true
|
|
352
|
+
}
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"name": "timeoutSeconds",
|
|
356
|
+
"in": "query",
|
|
357
|
+
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
|
|
358
|
+
"schema": {
|
|
359
|
+
"type": "integer",
|
|
360
|
+
"uniqueItems": true
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
],
|
|
364
|
+
"responses": {
|
|
365
|
+
"200": {
|
|
366
|
+
"description": "OK",
|
|
367
|
+
"content": {
|
|
368
|
+
"application/json": {
|
|
369
|
+
"schema": {
|
|
370
|
+
"$ref": "#/components/schemas/Status"
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"application/yaml": {
|
|
374
|
+
"schema": {
|
|
375
|
+
"$ref": "#/components/schemas/Status"
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"x-kubernetes-action": "deletecollection",
|
|
382
|
+
"x-kubernetes-group-version-kind": {
|
|
383
|
+
"group": "notifications.alerting.grafana.app",
|
|
384
|
+
"version": "v0alpha1",
|
|
385
|
+
"kind": "Config"
|
|
386
|
+
}
|
|
387
|
+
},
|
|
388
|
+
"parameters": [
|
|
389
|
+
{
|
|
390
|
+
"name": "pretty",
|
|
391
|
+
"in": "query",
|
|
392
|
+
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
393
|
+
"schema": {
|
|
394
|
+
"type": "string",
|
|
395
|
+
"uniqueItems": true
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
]
|
|
399
|
+
},
|
|
400
|
+
"/configs/{name}": {
|
|
401
|
+
"get": {
|
|
402
|
+
"tags": ["Config"],
|
|
403
|
+
"description": "read the specified Config",
|
|
404
|
+
"operationId": "getConfig",
|
|
405
|
+
"responses": {
|
|
406
|
+
"200": {
|
|
407
|
+
"description": "OK",
|
|
408
|
+
"content": {
|
|
409
|
+
"application/json": {
|
|
410
|
+
"schema": {
|
|
411
|
+
"$ref": "#/components/schemas/Config"
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
"application/yaml": {
|
|
415
|
+
"schema": {
|
|
416
|
+
"$ref": "#/components/schemas/Config"
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
},
|
|
422
|
+
"x-kubernetes-action": "get",
|
|
423
|
+
"x-kubernetes-group-version-kind": {
|
|
424
|
+
"group": "notifications.alerting.grafana.app",
|
|
425
|
+
"version": "v0alpha1",
|
|
426
|
+
"kind": "Config"
|
|
427
|
+
}
|
|
428
|
+
},
|
|
429
|
+
"put": {
|
|
430
|
+
"tags": ["Config"],
|
|
431
|
+
"description": "replace the specified Config",
|
|
432
|
+
"operationId": "replaceConfig",
|
|
433
|
+
"parameters": [
|
|
434
|
+
{
|
|
435
|
+
"name": "dryRun",
|
|
436
|
+
"in": "query",
|
|
437
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
438
|
+
"schema": {
|
|
439
|
+
"type": "string",
|
|
440
|
+
"uniqueItems": true
|
|
441
|
+
}
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"name": "fieldManager",
|
|
445
|
+
"in": "query",
|
|
446
|
+
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
447
|
+
"schema": {
|
|
448
|
+
"type": "string",
|
|
449
|
+
"uniqueItems": true
|
|
450
|
+
}
|
|
451
|
+
},
|
|
452
|
+
{
|
|
453
|
+
"name": "fieldValidation",
|
|
454
|
+
"in": "query",
|
|
455
|
+
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
456
|
+
"schema": {
|
|
457
|
+
"type": "string",
|
|
458
|
+
"uniqueItems": true
|
|
459
|
+
}
|
|
460
|
+
}
|
|
461
|
+
],
|
|
462
|
+
"requestBody": {
|
|
463
|
+
"content": {
|
|
464
|
+
"application/json": {
|
|
465
|
+
"schema": {
|
|
466
|
+
"$ref": "#/components/schemas/Config"
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"application/yaml": {
|
|
470
|
+
"schema": {
|
|
471
|
+
"$ref": "#/components/schemas/Config"
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"required": true
|
|
476
|
+
},
|
|
477
|
+
"responses": {
|
|
478
|
+
"200": {
|
|
479
|
+
"description": "OK",
|
|
480
|
+
"content": {
|
|
481
|
+
"application/json": {
|
|
482
|
+
"schema": {
|
|
483
|
+
"$ref": "#/components/schemas/Config"
|
|
484
|
+
}
|
|
485
|
+
},
|
|
486
|
+
"application/yaml": {
|
|
487
|
+
"schema": {
|
|
488
|
+
"$ref": "#/components/schemas/Config"
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
},
|
|
493
|
+
"201": {
|
|
494
|
+
"description": "Created",
|
|
495
|
+
"content": {
|
|
496
|
+
"application/json": {
|
|
497
|
+
"schema": {
|
|
498
|
+
"$ref": "#/components/schemas/Config"
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
"application/yaml": {
|
|
502
|
+
"schema": {
|
|
503
|
+
"$ref": "#/components/schemas/Config"
|
|
504
|
+
}
|
|
505
|
+
}
|
|
506
|
+
}
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
"x-kubernetes-action": "put",
|
|
510
|
+
"x-kubernetes-group-version-kind": {
|
|
511
|
+
"group": "notifications.alerting.grafana.app",
|
|
512
|
+
"version": "v0alpha1",
|
|
513
|
+
"kind": "Config"
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"delete": {
|
|
517
|
+
"tags": ["Config"],
|
|
518
|
+
"description": "delete a Config",
|
|
519
|
+
"operationId": "deleteConfig",
|
|
520
|
+
"parameters": [
|
|
521
|
+
{
|
|
522
|
+
"name": "dryRun",
|
|
523
|
+
"in": "query",
|
|
524
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
525
|
+
"schema": {
|
|
526
|
+
"type": "string",
|
|
527
|
+
"uniqueItems": true
|
|
528
|
+
}
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "gracePeriodSeconds",
|
|
532
|
+
"in": "query",
|
|
533
|
+
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
|
|
534
|
+
"schema": {
|
|
535
|
+
"type": "integer",
|
|
536
|
+
"uniqueItems": true
|
|
537
|
+
}
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "ignoreStoreReadErrorWithClusterBreakingPotential",
|
|
541
|
+
"in": "query",
|
|
542
|
+
"description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
|
|
543
|
+
"schema": {
|
|
544
|
+
"type": "boolean",
|
|
545
|
+
"uniqueItems": true
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "orphanDependents",
|
|
550
|
+
"in": "query",
|
|
551
|
+
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
|
|
552
|
+
"schema": {
|
|
553
|
+
"type": "boolean",
|
|
554
|
+
"uniqueItems": true
|
|
555
|
+
}
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
"name": "propagationPolicy",
|
|
559
|
+
"in": "query",
|
|
560
|
+
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
|
|
561
|
+
"schema": {
|
|
562
|
+
"type": "string",
|
|
563
|
+
"uniqueItems": true
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
],
|
|
567
|
+
"responses": {
|
|
568
|
+
"200": {
|
|
569
|
+
"description": "OK",
|
|
570
|
+
"content": {
|
|
571
|
+
"application/json": {
|
|
572
|
+
"schema": {
|
|
573
|
+
"$ref": "#/components/schemas/Status"
|
|
574
|
+
}
|
|
575
|
+
},
|
|
576
|
+
"application/yaml": {
|
|
577
|
+
"schema": {
|
|
578
|
+
"$ref": "#/components/schemas/Status"
|
|
579
|
+
}
|
|
580
|
+
}
|
|
581
|
+
}
|
|
582
|
+
},
|
|
583
|
+
"202": {
|
|
584
|
+
"description": "Accepted",
|
|
585
|
+
"content": {
|
|
586
|
+
"application/json": {
|
|
587
|
+
"schema": {
|
|
588
|
+
"$ref": "#/components/schemas/Status"
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
"application/yaml": {
|
|
592
|
+
"schema": {
|
|
593
|
+
"$ref": "#/components/schemas/Status"
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
"x-kubernetes-action": "delete",
|
|
600
|
+
"x-kubernetes-group-version-kind": {
|
|
601
|
+
"group": "notifications.alerting.grafana.app",
|
|
602
|
+
"version": "v0alpha1",
|
|
603
|
+
"kind": "Config"
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
"patch": {
|
|
607
|
+
"tags": ["Config"],
|
|
608
|
+
"description": "partially update the specified Config",
|
|
609
|
+
"operationId": "updateConfig",
|
|
610
|
+
"parameters": [
|
|
611
|
+
{
|
|
612
|
+
"name": "dryRun",
|
|
613
|
+
"in": "query",
|
|
614
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
615
|
+
"schema": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"uniqueItems": true
|
|
618
|
+
}
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"name": "fieldManager",
|
|
622
|
+
"in": "query",
|
|
623
|
+
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
|
|
624
|
+
"schema": {
|
|
625
|
+
"type": "string",
|
|
626
|
+
"uniqueItems": true
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "fieldValidation",
|
|
631
|
+
"in": "query",
|
|
632
|
+
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
633
|
+
"schema": {
|
|
634
|
+
"type": "string",
|
|
635
|
+
"uniqueItems": true
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "force",
|
|
640
|
+
"in": "query",
|
|
641
|
+
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
|
|
642
|
+
"schema": {
|
|
643
|
+
"type": "boolean",
|
|
644
|
+
"uniqueItems": true
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
],
|
|
648
|
+
"requestBody": {
|
|
649
|
+
"content": {
|
|
650
|
+
"application/apply-patch+yaml": {
|
|
651
|
+
"schema": {
|
|
652
|
+
"$ref": "#/components/schemas/Patch"
|
|
653
|
+
}
|
|
654
|
+
},
|
|
655
|
+
"application/json-patch+json": {
|
|
656
|
+
"schema": {
|
|
657
|
+
"$ref": "#/components/schemas/Patch"
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
"application/merge-patch+json": {
|
|
661
|
+
"schema": {
|
|
662
|
+
"$ref": "#/components/schemas/Patch"
|
|
663
|
+
}
|
|
664
|
+
},
|
|
665
|
+
"application/strategic-merge-patch+json": {
|
|
666
|
+
"schema": {
|
|
667
|
+
"$ref": "#/components/schemas/Patch"
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
},
|
|
671
|
+
"required": true
|
|
672
|
+
},
|
|
673
|
+
"responses": {
|
|
674
|
+
"200": {
|
|
675
|
+
"description": "OK",
|
|
676
|
+
"content": {
|
|
677
|
+
"application/json": {
|
|
678
|
+
"schema": {
|
|
679
|
+
"$ref": "#/components/schemas/Config"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"application/yaml": {
|
|
683
|
+
"schema": {
|
|
684
|
+
"$ref": "#/components/schemas/Config"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
"201": {
|
|
690
|
+
"description": "Created",
|
|
691
|
+
"content": {
|
|
692
|
+
"application/json": {
|
|
693
|
+
"schema": {
|
|
694
|
+
"$ref": "#/components/schemas/Config"
|
|
695
|
+
}
|
|
696
|
+
},
|
|
697
|
+
"application/yaml": {
|
|
698
|
+
"schema": {
|
|
699
|
+
"$ref": "#/components/schemas/Config"
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
}
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
"x-kubernetes-action": "patch",
|
|
706
|
+
"x-kubernetes-group-version-kind": {
|
|
707
|
+
"group": "notifications.alerting.grafana.app",
|
|
708
|
+
"version": "v0alpha1",
|
|
709
|
+
"kind": "Config"
|
|
710
|
+
}
|
|
711
|
+
},
|
|
712
|
+
"parameters": [
|
|
713
|
+
{
|
|
714
|
+
"name": "name",
|
|
715
|
+
"in": "path",
|
|
716
|
+
"description": "name of the Config",
|
|
717
|
+
"required": true,
|
|
718
|
+
"schema": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"uniqueItems": true
|
|
721
|
+
}
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"name": "pretty",
|
|
725
|
+
"in": "query",
|
|
726
|
+
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
727
|
+
"schema": {
|
|
728
|
+
"type": "string",
|
|
729
|
+
"uniqueItems": true
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
]
|
|
733
|
+
},
|
|
734
|
+
"/configs/{name}/status": {
|
|
735
|
+
"get": {
|
|
736
|
+
"tags": ["Config"],
|
|
737
|
+
"description": "read status of the specified Config",
|
|
738
|
+
"operationId": "getConfigStatus",
|
|
739
|
+
"responses": {
|
|
740
|
+
"200": {
|
|
741
|
+
"description": "OK",
|
|
742
|
+
"content": {
|
|
743
|
+
"application/json": {
|
|
744
|
+
"schema": {
|
|
745
|
+
"$ref": "#/components/schemas/Config"
|
|
746
|
+
}
|
|
747
|
+
},
|
|
748
|
+
"application/yaml": {
|
|
749
|
+
"schema": {
|
|
750
|
+
"$ref": "#/components/schemas/Config"
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
"x-kubernetes-action": "get",
|
|
757
|
+
"x-kubernetes-group-version-kind": {
|
|
758
|
+
"group": "notifications.alerting.grafana.app",
|
|
759
|
+
"version": "v0alpha1",
|
|
760
|
+
"kind": "Config"
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
"put": {
|
|
764
|
+
"tags": ["Config"],
|
|
765
|
+
"description": "replace status of the specified Config",
|
|
766
|
+
"operationId": "replaceConfigStatus",
|
|
767
|
+
"parameters": [
|
|
768
|
+
{
|
|
769
|
+
"name": "dryRun",
|
|
770
|
+
"in": "query",
|
|
771
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
772
|
+
"schema": {
|
|
773
|
+
"type": "string",
|
|
774
|
+
"uniqueItems": true
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
"name": "fieldManager",
|
|
779
|
+
"in": "query",
|
|
780
|
+
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
781
|
+
"schema": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"uniqueItems": true
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "fieldValidation",
|
|
788
|
+
"in": "query",
|
|
789
|
+
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
790
|
+
"schema": {
|
|
791
|
+
"type": "string",
|
|
792
|
+
"uniqueItems": true
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
],
|
|
796
|
+
"requestBody": {
|
|
797
|
+
"content": {
|
|
798
|
+
"application/json": {
|
|
799
|
+
"schema": {
|
|
800
|
+
"$ref": "#/components/schemas/Config"
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
"application/yaml": {
|
|
804
|
+
"schema": {
|
|
805
|
+
"$ref": "#/components/schemas/Config"
|
|
806
|
+
}
|
|
807
|
+
}
|
|
808
|
+
},
|
|
809
|
+
"required": true
|
|
810
|
+
},
|
|
811
|
+
"responses": {
|
|
812
|
+
"200": {
|
|
813
|
+
"description": "OK",
|
|
814
|
+
"content": {
|
|
815
|
+
"application/json": {
|
|
816
|
+
"schema": {
|
|
817
|
+
"$ref": "#/components/schemas/Config"
|
|
818
|
+
}
|
|
819
|
+
},
|
|
820
|
+
"application/yaml": {
|
|
821
|
+
"schema": {
|
|
822
|
+
"$ref": "#/components/schemas/Config"
|
|
823
|
+
}
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
},
|
|
827
|
+
"201": {
|
|
828
|
+
"description": "Created",
|
|
829
|
+
"content": {
|
|
830
|
+
"application/json": {
|
|
831
|
+
"schema": {
|
|
832
|
+
"$ref": "#/components/schemas/Config"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"application/yaml": {
|
|
836
|
+
"schema": {
|
|
837
|
+
"$ref": "#/components/schemas/Config"
|
|
838
|
+
}
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
}
|
|
842
|
+
},
|
|
843
|
+
"x-kubernetes-action": "put",
|
|
844
|
+
"x-kubernetes-group-version-kind": {
|
|
845
|
+
"group": "notifications.alerting.grafana.app",
|
|
846
|
+
"version": "v0alpha1",
|
|
847
|
+
"kind": "Config"
|
|
848
|
+
}
|
|
849
|
+
},
|
|
850
|
+
"patch": {
|
|
851
|
+
"tags": ["Config"],
|
|
852
|
+
"description": "partially update status of the specified Config",
|
|
853
|
+
"operationId": "updateConfigStatus",
|
|
854
|
+
"parameters": [
|
|
855
|
+
{
|
|
856
|
+
"name": "dryRun",
|
|
857
|
+
"in": "query",
|
|
858
|
+
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
859
|
+
"schema": {
|
|
860
|
+
"type": "string",
|
|
861
|
+
"uniqueItems": true
|
|
862
|
+
}
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"name": "fieldManager",
|
|
866
|
+
"in": "query",
|
|
867
|
+
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
|
|
868
|
+
"schema": {
|
|
869
|
+
"type": "string",
|
|
870
|
+
"uniqueItems": true
|
|
871
|
+
}
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"name": "fieldValidation",
|
|
875
|
+
"in": "query",
|
|
876
|
+
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
877
|
+
"schema": {
|
|
878
|
+
"type": "string",
|
|
879
|
+
"uniqueItems": true
|
|
880
|
+
}
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "force",
|
|
884
|
+
"in": "query",
|
|
885
|
+
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
|
|
886
|
+
"schema": {
|
|
887
|
+
"type": "boolean",
|
|
888
|
+
"uniqueItems": true
|
|
889
|
+
}
|
|
890
|
+
}
|
|
891
|
+
],
|
|
892
|
+
"requestBody": {
|
|
893
|
+
"content": {
|
|
894
|
+
"application/apply-patch+yaml": {
|
|
895
|
+
"schema": {
|
|
896
|
+
"$ref": "#/components/schemas/Patch"
|
|
897
|
+
}
|
|
898
|
+
},
|
|
899
|
+
"application/json-patch+json": {
|
|
900
|
+
"schema": {
|
|
901
|
+
"$ref": "#/components/schemas/Patch"
|
|
902
|
+
}
|
|
903
|
+
},
|
|
904
|
+
"application/merge-patch+json": {
|
|
905
|
+
"schema": {
|
|
906
|
+
"$ref": "#/components/schemas/Patch"
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
"application/strategic-merge-patch+json": {
|
|
910
|
+
"schema": {
|
|
911
|
+
"$ref": "#/components/schemas/Patch"
|
|
912
|
+
}
|
|
913
|
+
}
|
|
914
|
+
},
|
|
915
|
+
"required": true
|
|
916
|
+
},
|
|
917
|
+
"responses": {
|
|
918
|
+
"200": {
|
|
919
|
+
"description": "OK",
|
|
920
|
+
"content": {
|
|
921
|
+
"application/json": {
|
|
922
|
+
"schema": {
|
|
923
|
+
"$ref": "#/components/schemas/Config"
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"application/yaml": {
|
|
927
|
+
"schema": {
|
|
928
|
+
"$ref": "#/components/schemas/Config"
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
"201": {
|
|
934
|
+
"description": "Created",
|
|
935
|
+
"content": {
|
|
936
|
+
"application/json": {
|
|
937
|
+
"schema": {
|
|
938
|
+
"$ref": "#/components/schemas/Config"
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
"application/yaml": {
|
|
942
|
+
"schema": {
|
|
943
|
+
"$ref": "#/components/schemas/Config"
|
|
944
|
+
}
|
|
945
|
+
}
|
|
946
|
+
}
|
|
947
|
+
}
|
|
948
|
+
},
|
|
949
|
+
"x-kubernetes-action": "patch",
|
|
950
|
+
"x-kubernetes-group-version-kind": {
|
|
951
|
+
"group": "notifications.alerting.grafana.app",
|
|
952
|
+
"version": "v0alpha1",
|
|
953
|
+
"kind": "Config"
|
|
954
|
+
}
|
|
955
|
+
},
|
|
956
|
+
"parameters": [
|
|
957
|
+
{
|
|
958
|
+
"name": "name",
|
|
959
|
+
"in": "path",
|
|
960
|
+
"description": "name of the Config",
|
|
961
|
+
"required": true,
|
|
962
|
+
"schema": {
|
|
963
|
+
"type": "string",
|
|
964
|
+
"uniqueItems": true
|
|
965
|
+
}
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
"name": "pretty",
|
|
969
|
+
"in": "query",
|
|
970
|
+
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
971
|
+
"schema": {
|
|
972
|
+
"type": "string",
|
|
973
|
+
"uniqueItems": true
|
|
974
|
+
}
|
|
975
|
+
}
|
|
976
|
+
]
|
|
977
|
+
},
|
|
31
978
|
"/inhibitionrules": {
|
|
32
979
|
"get": {
|
|
33
980
|
"tags": ["InhibitionRule"],
|
|
@@ -3611,6 +4558,157 @@
|
|
|
3611
4558
|
},
|
|
3612
4559
|
"components": {
|
|
3613
4560
|
"schemas": {
|
|
4561
|
+
"Config": {
|
|
4562
|
+
"type": "object",
|
|
4563
|
+
"required": ["kind", "apiVersion", "metadata", "spec"],
|
|
4564
|
+
"properties": {
|
|
4565
|
+
"apiVersion": {
|
|
4566
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4567
|
+
"type": "string"
|
|
4568
|
+
},
|
|
4569
|
+
"kind": {
|
|
4570
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4571
|
+
"type": "string"
|
|
4572
|
+
},
|
|
4573
|
+
"metadata": {
|
|
4574
|
+
"default": {},
|
|
4575
|
+
"allOf": [
|
|
4576
|
+
{
|
|
4577
|
+
"$ref": "#/components/schemas/ObjectMeta"
|
|
4578
|
+
}
|
|
4579
|
+
]
|
|
4580
|
+
},
|
|
4581
|
+
"spec": {
|
|
4582
|
+
"$ref": "#/components/schemas/ConfigSpec"
|
|
4583
|
+
},
|
|
4584
|
+
"status": {
|
|
4585
|
+
"$ref": "#/components/schemas/ConfigStatus"
|
|
4586
|
+
}
|
|
4587
|
+
},
|
|
4588
|
+
"x-kubernetes-group-version-kind": [
|
|
4589
|
+
{
|
|
4590
|
+
"group": "notifications.alerting.grafana.app",
|
|
4591
|
+
"kind": "Config",
|
|
4592
|
+
"version": "v0alpha1"
|
|
4593
|
+
}
|
|
4594
|
+
]
|
|
4595
|
+
},
|
|
4596
|
+
"ConfigCondition": {
|
|
4597
|
+
"description": "Condition mirrors metav1.Condition. Inlined because the app-sdk codegen\nhere can't reference metav1.Condition from CUE. Field semantics are\nk8s-standard; reason values are produced by SyncReason in the syncer.",
|
|
4598
|
+
"type": "object",
|
|
4599
|
+
"required": ["type", "status", "lastTransitionTime", "reason"],
|
|
4600
|
+
"properties": {
|
|
4601
|
+
"lastTransitionTime": {
|
|
4602
|
+
"description": "RFC3339",
|
|
4603
|
+
"type": "string"
|
|
4604
|
+
},
|
|
4605
|
+
"message": {
|
|
4606
|
+
"type": "string"
|
|
4607
|
+
},
|
|
4608
|
+
"observedGeneration": {
|
|
4609
|
+
"type": "integer"
|
|
4610
|
+
},
|
|
4611
|
+
"reason": {
|
|
4612
|
+
"type": "string"
|
|
4613
|
+
},
|
|
4614
|
+
"status": {
|
|
4615
|
+
"type": "string",
|
|
4616
|
+
"enum": ["True", "False", "Unknown"]
|
|
4617
|
+
},
|
|
4618
|
+
"type": {
|
|
4619
|
+
"type": "string"
|
|
4620
|
+
}
|
|
4621
|
+
},
|
|
4622
|
+
"additionalProperties": false
|
|
4623
|
+
},
|
|
4624
|
+
"ConfigList": {
|
|
4625
|
+
"type": "object",
|
|
4626
|
+
"required": ["metadata", "items"],
|
|
4627
|
+
"properties": {
|
|
4628
|
+
"apiVersion": {
|
|
4629
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4630
|
+
"type": "string"
|
|
4631
|
+
},
|
|
4632
|
+
"items": {
|
|
4633
|
+
"type": "array",
|
|
4634
|
+
"items": {
|
|
4635
|
+
"default": {},
|
|
4636
|
+
"allOf": [
|
|
4637
|
+
{
|
|
4638
|
+
"$ref": "#/components/schemas/Config"
|
|
4639
|
+
}
|
|
4640
|
+
]
|
|
4641
|
+
}
|
|
4642
|
+
},
|
|
4643
|
+
"kind": {
|
|
4644
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4645
|
+
"type": "string"
|
|
4646
|
+
},
|
|
4647
|
+
"metadata": {
|
|
4648
|
+
"default": {},
|
|
4649
|
+
"allOf": [
|
|
4650
|
+
{
|
|
4651
|
+
"$ref": "#/components/schemas/ListMeta"
|
|
4652
|
+
}
|
|
4653
|
+
]
|
|
4654
|
+
}
|
|
4655
|
+
},
|
|
4656
|
+
"x-kubernetes-group-version-kind": [
|
|
4657
|
+
{
|
|
4658
|
+
"group": "notifications.alerting.grafana.app",
|
|
4659
|
+
"kind": "ConfigList",
|
|
4660
|
+
"version": "v0alpha1"
|
|
4661
|
+
}
|
|
4662
|
+
]
|
|
4663
|
+
},
|
|
4664
|
+
"ConfigSpec": {
|
|
4665
|
+
"type": "object",
|
|
4666
|
+
"properties": {
|
|
4667
|
+
"externalAlertmanagerSync": {
|
|
4668
|
+
"type": "object",
|
|
4669
|
+
"properties": {
|
|
4670
|
+
"datasourceUid": {
|
|
4671
|
+
"description": "datasourceUid is the UID of the Mimir/Cortex Alertmanager datasource to\nsync from. Empty means no sync is configured for the current org. The\noperator ini setting `unified_alerting.external_alertmanager_uid`\noverrides this when set; see status.externalAlertmanagerSync.origin.",
|
|
4672
|
+
"type": "string"
|
|
4673
|
+
}
|
|
4674
|
+
},
|
|
4675
|
+
"additionalProperties": false
|
|
4676
|
+
}
|
|
4677
|
+
},
|
|
4678
|
+
"additionalProperties": false
|
|
4679
|
+
},
|
|
4680
|
+
"ConfigStatus": {
|
|
4681
|
+
"type": "object",
|
|
4682
|
+
"properties": {
|
|
4683
|
+
"conditions": {
|
|
4684
|
+
"description": "Standard k8s-style condition list. Each binary-state feature owns one\ncondition type. Current types:\n - ExternalAlertmanagerSynced: True after a successful sync, False\n after a failed attempt, Unknown until the first attempt.",
|
|
4685
|
+
"type": "array",
|
|
4686
|
+
"items": {
|
|
4687
|
+
"$ref": "#/components/schemas/ConfigCondition"
|
|
4688
|
+
}
|
|
4689
|
+
},
|
|
4690
|
+
"externalAlertmanagerSync": {
|
|
4691
|
+
"type": "object",
|
|
4692
|
+
"properties": {
|
|
4693
|
+
"datasourceUid": {
|
|
4694
|
+
"description": "datasourceUid is the UID actually used on the last sync attempt; may lag\nspec until the next tick. When origin=ini, this is the ini override value.",
|
|
4695
|
+
"type": "string"
|
|
4696
|
+
},
|
|
4697
|
+
"origin": {
|
|
4698
|
+
"description": "origin records which source supplied datasourceUid on the last run. \"ini\"\n(grafana.ini's unified_alerting.external_alertmanager_uid) wins over \"api\"\n(spec.externalAlertmanagerSync.datasourceUid).",
|
|
4699
|
+
"type": "string",
|
|
4700
|
+
"enum": ["api", "ini"]
|
|
4701
|
+
}
|
|
4702
|
+
},
|
|
4703
|
+
"additionalProperties": false
|
|
4704
|
+
},
|
|
4705
|
+
"observedGeneration": {
|
|
4706
|
+
"description": "observedGeneration is the spec.generation last evaluated by the\ncontrollers writing this status.",
|
|
4707
|
+
"type": "integer"
|
|
4708
|
+
}
|
|
4709
|
+
},
|
|
4710
|
+
"additionalProperties": false
|
|
4711
|
+
},
|
|
3614
4712
|
"CreateReceiverIntegrationTestResponse": {
|
|
3615
4713
|
"type": "object",
|
|
3616
4714
|
"required": ["status", "duration", "apiVersion", "kind"],
|
|
@@ -4958,6 +6056,29 @@
|
|
|
4958
6056
|
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
|
|
4959
6057
|
"type": "string",
|
|
4960
6058
|
"format": "date-time"
|
|
6059
|
+
},
|
|
6060
|
+
"WatchEvent": {
|
|
6061
|
+
"description": "Event represents a single event to a watched resource.",
|
|
6062
|
+
"type": "object",
|
|
6063
|
+
"required": ["type", "object"],
|
|
6064
|
+
"properties": {
|
|
6065
|
+
"object": {
|
|
6066
|
+
"description": "Object is:\n * If Type is Added or Modified: the new state of the object.\n * If Type is Deleted: the state of the object immediately before deletion.\n * If Type is Error: *Status is recommended; other types may make sense\n depending on context.",
|
|
6067
|
+
"allOf": [
|
|
6068
|
+
{
|
|
6069
|
+
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.runtime.RawExtension"
|
|
6070
|
+
}
|
|
6071
|
+
]
|
|
6072
|
+
},
|
|
6073
|
+
"type": {
|
|
6074
|
+
"type": "string",
|
|
6075
|
+
"default": ""
|
|
6076
|
+
}
|
|
6077
|
+
}
|
|
6078
|
+
},
|
|
6079
|
+
"io.k8s.apimachinery.pkg.runtime.RawExtension": {
|
|
6080
|
+
"description": "RawExtension is used to hold extensions in external versions.\n\nTo use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.\n\n// Internal package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.Object `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// External package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.RawExtension `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// On the wire, the JSON will look something like this:\n\n\t{\n\t\t\"kind\":\"MyAPIObject\",\n\t\t\"apiVersion\":\"v1\",\n\t\t\"myPlugin\": {\n\t\t\t\"kind\":\"PluginA\",\n\t\t\t\"aOption\":\"foo\",\n\t\t},\n\t}\n\nSo what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)",
|
|
6081
|
+
"type": "object"
|
|
4961
6082
|
}
|
|
4962
6083
|
}
|
|
4963
6084
|
}
|