@grafana/openapi 13.2.3 → 13.3.0

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.
Files changed (29) hide show
  1. package/dist/api/openapi3.json +358 -247
  2. package/dist/apis/collections.grafana.app-v1alpha1.json +3 -14
  3. package/dist/apis/correlations.grafana.app-v0alpha1.json +411 -0
  4. package/dist/apis/dashboard.grafana.app-v0alpha1.json +865 -105
  5. package/dist/apis/dashboard.grafana.app-v1beta1.json +733 -6
  6. package/dist/apis/dashboard.grafana.app-v2.json +821 -194
  7. package/dist/apis/dashboard.grafana.app-v2alpha1.json +803 -208
  8. package/dist/apis/dashboard.grafana.app-v2beta1.json +985 -374
  9. package/dist/apis/folder.grafana.app-v1.json +644 -20
  10. package/dist/apis/folder.grafana.app-v1beta1.json +644 -20
  11. package/dist/apis/grafana-testdata-datasource.datasource.grafana.app-v0alpha1.json +3 -21
  12. package/dist/apis/historian.alerting.grafana.app-v0alpha1.json +411 -0
  13. package/dist/apis/iam.grafana.app-v0alpha1.json +2397 -748
  14. package/dist/apis/logsdrilldown.grafana.app-v1beta1.json +448 -0
  15. package/dist/apis/notifications.alerting.grafana.app-v0alpha1.json +596 -0
  16. package/dist/apis/notifications.alerting.grafana.app-v1beta1.json +596 -0
  17. package/dist/apis/playlist.grafana.app-v0alpha1.json +415 -0
  18. package/dist/apis/playlist.grafana.app-v1.json +415 -0
  19. package/dist/apis/preferences.grafana.app-v1.json +3 -9
  20. package/dist/apis/preferences.grafana.app-v1alpha1.json +3 -9
  21. package/dist/apis/provisioning.grafana.app-v0alpha1.json +649 -151
  22. package/dist/apis/provisioning.grafana.app-v1beta1.json +634 -100
  23. package/dist/apis/query.grafana.app-v0alpha1.json +14 -11
  24. package/dist/apis/quotas.grafana.app-v0alpha1.json +1 -2
  25. package/dist/apis/rules.alerting.grafana.app-v0alpha1.json +3027 -767
  26. package/dist/apis/rules.alerting.grafana.app-v1beta1.json +4541 -0
  27. package/dist/apis/search.grafana.app-v0alpha1.json +693 -0
  28. package/dist/apis/shorturl.grafana.app-v1beta1.json +411 -0
  29. package/package.json +3 -3
@@ -15,6 +15,13 @@
15
15
  "description": "(empty)"
16
16
  },
17
17
  "SMTPNotEnabledError": {
18
+ "content": {
19
+ "application/json": {
20
+ "schema": {
21
+ "$ref": "#/components/schemas/ErrorResponseBody"
22
+ }
23
+ }
24
+ },
18
25
  "description": "(empty)"
19
26
  },
20
27
  "StateHistory": {
@@ -600,7 +607,7 @@
600
607
  "content": {
601
608
  "application/json": {
602
609
  "schema": {
603
- "$ref": "#/components/schemas/Status"
610
+ "$ref": "#/components/schemas/AccessControlStatus"
604
611
  }
605
612
  }
606
613
  },
@@ -712,6 +719,13 @@
712
719
  "description": "(empty)"
713
720
  },
714
721
  "getDashboardSnapshotResponse": {
722
+ "content": {
723
+ "application/json": {
724
+ "schema": {
725
+ "$ref": "#/components/schemas/DashboardFullWithMeta"
726
+ }
727
+ }
728
+ },
715
729
  "description": "(empty)"
716
730
  },
717
731
  "getDashboardsTagsResponse": {
@@ -1192,6 +1206,13 @@
1192
1206
  "description": "(empty)"
1193
1207
  },
1194
1208
  "getStatusResponse": {
1209
+ "content": {
1210
+ "application/json": {
1211
+ "schema": {
1212
+ "type": "boolean"
1213
+ }
1214
+ }
1215
+ },
1195
1216
  "description": "(empty)"
1196
1217
  },
1197
1218
  "getSyncStatusResponse": {
@@ -1627,6 +1648,13 @@
1627
1648
  "description": "(empty)"
1628
1649
  },
1629
1650
  "postRenewLicenseTokenResponse": {
1651
+ "content": {
1652
+ "application/json": {
1653
+ "schema": {
1654
+ "type": "boolean"
1655
+ }
1656
+ }
1657
+ },
1630
1658
  "description": "(empty)"
1631
1659
  },
1632
1660
  "preconditionFailedError": {
@@ -2022,6 +2050,14 @@
2022
2050
  }
2023
2051
  },
2024
2052
  "schemas": {
2053
+ "AccessControlStatus": {
2054
+ "properties": {
2055
+ "enabled": {
2056
+ "type": "boolean"
2057
+ }
2058
+ },
2059
+ "type": "object"
2060
+ },
2025
2061
  "Ack": {
2026
2062
  "type": "object"
2027
2063
  },
@@ -2685,6 +2721,11 @@
2685
2721
  },
2686
2722
  "type": "array"
2687
2723
  },
2724
+ "policy": {
2725
+ "description": "Name of the notification policy to route alerts through.\nMutually exclusive with all other fields, cannot be used with contact point routing via the \"receiver\" field.",
2726
+ "example": "\"Alerting Team\"",
2727
+ "type": "string"
2728
+ },
2688
2729
  "receiver": {
2689
2730
  "description": "Name of the receiver to send notifications to.",
2690
2731
  "example": "grafana-default-email",
@@ -2924,7 +2965,8 @@
2924
2965
  "dashboardId": {
2925
2966
  "description": "Deprecated: Use DashboardUID and OrgID instead",
2926
2967
  "format": "int64",
2927
- "type": "integer"
2968
+ "type": "integer",
2969
+ "x-deprecated": true
2928
2970
  },
2929
2971
  "dashboardUID": {
2930
2972
  "type": "string"
@@ -2984,7 +3026,6 @@
2984
3026
  "type": "object"
2985
3027
  },
2986
3028
  "AnnotationActions": {
2987
- "description": "+k8s:deepcopy-gen=true",
2988
3029
  "properties": {
2989
3030
  "canAdd": {
2990
3031
  "type": "boolean"
@@ -3062,7 +3103,6 @@
3062
3103
  "type": "object"
3063
3104
  },
3064
3105
  "AnnotationPermission": {
3065
- "description": "+k8s:deepcopy-gen=true",
3066
3106
  "properties": {
3067
3107
  "dashboard": {
3068
3108
  "$ref": "#/components/schemas/AnnotationActions"
@@ -3190,13 +3230,14 @@
3190
3230
  "type": "object"
3191
3231
  },
3192
3232
  "AttributeTypeAndValue": {
3193
- "description": "AttributeTypeAndValue mirrors the ASN.1 structure of the same name in\nRFC 5280, Section 4.1.2.4.",
3233
+ "description": "When parsed as part of a pkix.Name structure in a crypto/x509 type,\nthe Value will be\n\n- a string if the ASN.1 type is PrintableString, IA5String,\nNumericString, BMPString, T61String, or UTF8String;\n- an int64 if the ASN.1 type is INTEGER;\n- an asn1.BitString if the ASN.1 type is BIT STRING;\n- a []byte if the ASN.1 type is OCTET STRING;\n- an asn1.ObjectIdentifier if the ASN.1 type is OBJECT IDENTIFIER;\n- a time.Time if the ASN.1 type is UTCTIME or GENERALIZEDTIME;\n- a bool if the ASN.1 type is BOOLEAN;\n- nil if the ASN.1 type is NULL;\n- an asn1.RawValue otherwise.",
3194
3234
  "properties": {
3195
3235
  "Type": {
3196
3236
  "$ref": "#/components/schemas/ObjectIdentifier"
3197
3237
  },
3198
3238
  "Value": {}
3199
3239
  },
3240
+ "title": "AttributeTypeAndValue mirrors the ASN.1 structure of the same name in\nRFC 5280, Section 4.1.2.4.",
3200
3241
  "type": "object"
3201
3242
  },
3202
3243
  "Authorization": {
@@ -3566,6 +3607,10 @@
3566
3607
  "description": "MaxPathLenZero indicates that BasicConstraintsValid==true\nand MaxPathLen==0 should be interpreted as an actual\nmaximum path length of zero. Otherwise, that combination is\ninterpreted as MaxPathLen not being set.",
3567
3608
  "type": "boolean"
3568
3609
  },
3610
+ "NotAfter": {
3611
+ "format": "date-time",
3612
+ "type": "string"
3613
+ },
3569
3614
  "NotBefore": {
3570
3615
  "format": "date-time",
3571
3616
  "type": "string"
@@ -3644,6 +3689,13 @@
3644
3689
  },
3645
3690
  "type": "array"
3646
3691
  },
3692
+ "RawSignatureAlgorithm": {
3693
+ "items": {
3694
+ "format": "uint8",
3695
+ "type": "integer"
3696
+ },
3697
+ "type": "array"
3698
+ },
3647
3699
  "RawSubject": {
3648
3700
  "items": {
3649
3701
  "format": "uint8",
@@ -3675,7 +3727,7 @@
3675
3727
  "type": "boolean"
3676
3728
  },
3677
3729
  "SerialNumber": {
3678
- "type": "string"
3730
+ "type": "integer"
3679
3731
  },
3680
3732
  "Signature": {
3681
3733
  "items": {
@@ -3851,6 +3903,26 @@
3851
3903
  },
3852
3904
  "type": "array"
3853
3905
  },
3906
+ "ConvertAlertmanagerResponse": {
3907
+ "properties": {
3908
+ "error": {
3909
+ "type": "string"
3910
+ },
3911
+ "errorType": {
3912
+ "type": "string"
3913
+ },
3914
+ "rename_resources": {
3915
+ "$ref": "#/components/schemas/RenameResources"
3916
+ },
3917
+ "stats": {
3918
+ "$ref": "#/components/schemas/MergeStats"
3919
+ },
3920
+ "status": {
3921
+ "type": "string"
3922
+ }
3923
+ },
3924
+ "type": "object"
3925
+ },
3854
3926
  "ConvertPrometheusResponse": {
3855
3927
  "properties": {
3856
3928
  "error": {
@@ -3975,7 +4047,7 @@
3975
4047
  "type": "object"
3976
4048
  },
3977
4049
  "CorrelationType": {
3978
- "description": "the type of correlation, either query for containing query information, or external for containing an external URL\n+enum",
4050
+ "description": "the type of correlation, either query for containing query information, or external for containing an external URL",
3979
4051
  "type": "string"
3980
4052
  },
3981
4053
  "CounterResetHint": {
@@ -4039,7 +4111,7 @@
4039
4111
  "CreateDashboardSnapshotCommand": {
4040
4112
  "properties": {
4041
4113
  "apiVersion": {
4042
- "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional",
4114
+ "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
4043
4115
  "type": "string"
4044
4116
  },
4045
4117
  "dashboard": {
@@ -4065,7 +4137,7 @@
4065
4137
  "type": "string"
4066
4138
  },
4067
4139
  "kind": {
4068
- "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional",
4140
+ "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
4069
4141
  "type": "string"
4070
4142
  },
4071
4143
  "name": {
@@ -4100,14 +4172,15 @@
4100
4172
  "folderId": {
4101
4173
  "description": "ID of the folder where the library element is stored.\n\nDeprecated: use FolderUID instead",
4102
4174
  "format": "int64",
4103
- "type": "integer"
4175
+ "type": "integer",
4176
+ "x-deprecated": true
4104
4177
  },
4105
4178
  "folderUid": {
4106
4179
  "description": "UID of the folder where the library element is stored.",
4107
4180
  "type": "string"
4108
4181
  },
4109
4182
  "kind": {
4110
- "description": "Kind of element to create, Use 1 for library panels or 2 for c.\nDescription:\n1 - library panels",
4183
+ "description": "Kind of element to create, Use 1 for library panels or 2 for c.\nDescription:\n- 1 - library panels",
4111
4184
  "enum": [1],
4112
4185
  "format": "int64",
4113
4186
  "type": "integer"
@@ -4330,7 +4403,8 @@
4330
4403
  "folderId": {
4331
4404
  "description": "Deprecated: use FolderUID instead",
4332
4405
  "format": "int64",
4333
- "type": "integer"
4406
+ "type": "integer",
4407
+ "x-deprecated": true
4334
4408
  },
4335
4409
  "folderUid": {
4336
4410
  "type": "string"
@@ -4342,7 +4416,7 @@
4342
4416
  "type": "boolean"
4343
4417
  },
4344
4418
  "permission": {
4345
- "$ref": "#/components/schemas/PermissionType"
4419
+ "$ref": "#/components/schemas/DashboardaccessPermissionType"
4346
4420
  },
4347
4421
  "permissionName": {
4348
4422
  "type": "string"
@@ -4405,7 +4479,7 @@
4405
4479
  "DashboardACLUpdateItem": {
4406
4480
  "properties": {
4407
4481
  "permission": {
4408
- "$ref": "#/components/schemas/PermissionType"
4482
+ "$ref": "#/components/schemas/DashboardaccessPermissionType"
4409
4483
  },
4410
4484
  "role": {
4411
4485
  "enum": ["None", "Viewer", "Editor", "Admin"],
@@ -4423,10 +4497,10 @@
4423
4497
  "type": "object"
4424
4498
  },
4425
4499
  "DashboardCreateCommand": {
4426
- "description": "These are the values expected to be sent from an end user\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object",
4500
+ "description": "These are the values expected to be sent from an end user",
4427
4501
  "properties": {
4428
4502
  "apiVersion": {
4429
- "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional",
4503
+ "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
4430
4504
  "type": "string"
4431
4505
  },
4432
4506
  "dashboard": {
@@ -4444,7 +4518,7 @@
4444
4518
  "type": "boolean"
4445
4519
  },
4446
4520
  "kind": {
4447
- "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional",
4521
+ "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
4448
4522
  "type": "string"
4449
4523
  },
4450
4524
  "name": {
@@ -4503,7 +4577,8 @@
4503
4577
  "folderId": {
4504
4578
  "description": "Deprecated: use FolderUID instead",
4505
4579
  "format": "int64",
4506
- "type": "integer"
4580
+ "type": "integer",
4581
+ "x-deprecated": true
4507
4582
  },
4508
4583
  "folderTitle": {
4509
4584
  "type": "string"
@@ -4555,14 +4630,6 @@
4555
4630
  },
4556
4631
  "type": "object"
4557
4632
  },
4558
- "DashboardRedirect": {
4559
- "properties": {
4560
- "redirectUri": {
4561
- "type": "string"
4562
- }
4563
- },
4564
- "type": "object"
4565
- },
4566
4633
  "DashboardSnapshotDTO": {
4567
4634
  "description": "DashboardSnapshotDTO without dashboard map",
4568
4635
  "properties": {
@@ -4661,6 +4728,10 @@
4661
4728
  },
4662
4729
  "type": "object"
4663
4730
  },
4731
+ "DashboardaccessPermissionType": {
4732
+ "format": "int64",
4733
+ "type": "integer"
4734
+ },
4664
4735
  "DataLink": {
4665
4736
  "description": "DataLink define what",
4666
4737
  "properties": {
@@ -4840,7 +4911,6 @@
4840
4911
  "type": "object"
4841
4912
  },
4842
4913
  "DataTopic": {
4843
- "description": "nolint:revive",
4844
4914
  "title": "DataTopic is used to identify which topic the frame should be assigned to.",
4845
4915
  "type": "string"
4846
4916
  },
@@ -4951,7 +5021,7 @@
4951
5021
  "type": "string"
4952
5022
  },
4953
5023
  "DsPermissionType": {
4954
- "description": "Datasource permission\nDescription:\n`0` - No Access\n`1` - Query\n`2` - Edit\nEnum: 0,1,2",
5024
+ "description": "Datasource permission\nDescription:\n- `0` - No Access\n- `1` - Query\n- `2` - Edit",
4955
5025
  "format": "int64",
4956
5026
  "type": "integer"
4957
5027
  },
@@ -5261,7 +5331,6 @@
5261
5331
  },
5262
5332
  "uptime": {
5263
5333
  "description": "uptime",
5264
- "format": "date-time",
5265
5334
  "type": "string"
5266
5335
  },
5267
5336
  "versionInfo": {
@@ -5279,8 +5348,9 @@
5279
5348
  "identifier": {
5280
5349
  "type": "string"
5281
5350
  },
5282
- "merge_matchers": {
5283
- "$ref": "#/components/schemas/Matchers"
5351
+ "managed_by": {
5352
+ "description": "ManagedBy is \"manual\" or \"auto-sync\", computed server-side so callers don't need configs:get\nto tell the two apart.",
5353
+ "type": "string"
5284
5354
  },
5285
5355
  "template_files": {
5286
5356
  "additionalProperties": {
@@ -5511,7 +5581,8 @@
5511
5581
  "id": {
5512
5582
  "description": "Deprecated: use UID instead",
5513
5583
  "format": "int64",
5514
- "type": "integer"
5584
+ "type": "integer",
5585
+ "x-deprecated": true
5515
5586
  },
5516
5587
  "managedBy": {
5517
5588
  "$ref": "#/components/schemas/ManagerKind"
@@ -5704,7 +5775,7 @@
5704
5775
  "type": "object"
5705
5776
  },
5706
5777
  "FrameType": {
5707
- "description": "A FrameType string, when present in a frame's metadata, asserts that the\nframe's structure conforms to the FrameType's specification.\nThis property is currently optional, so FrameType may be FrameTypeUnknown even if the properties of\nthe Frame correspond to a defined FrameType.\n+enum",
5778
+ "description": "A FrameType string, when present in a frame's metadata, asserts that the\nframe's structure conforms to the FrameType's specification.\nThis property is currently optional, so FrameType may be FrameTypeUnknown even if the properties of\nthe Frame correspond to a defined FrameType.",
5708
5779
  "type": "string"
5709
5780
  },
5710
5781
  "FrameTypeVersion": {
@@ -6047,6 +6118,9 @@
6047
6118
  },
6048
6119
  "uid": {
6049
6120
  "type": "string"
6121
+ },
6122
+ "version": {
6123
+ "type": "string"
6050
6124
  }
6051
6125
  },
6052
6126
  "type": "object"
@@ -6147,7 +6221,6 @@
6147
6221
  "type": "integer"
6148
6222
  },
6149
6223
  "last_applied": {
6150
- "format": "date-time",
6151
6224
  "type": "string"
6152
6225
  },
6153
6226
  "template_file_provenances": {
@@ -6170,6 +6243,10 @@
6170
6243
  "alertmanagersChoice": {
6171
6244
  "enum": ["all", "internal", "external"],
6172
6245
  "type": "string"
6246
+ },
6247
+ "external_alertmanager_uid": {
6248
+ "description": "ExternalAlertmanagerUID is the UID of the Mimir/Cortex Alertmanager datasource being\nsynced, or empty if sync is not configured for this org.",
6249
+ "type": "string"
6173
6250
  }
6174
6251
  },
6175
6252
  "type": "object"
@@ -6238,7 +6315,6 @@
6238
6315
  },
6239
6316
  "uptime": {
6240
6317
  "description": "uptime",
6241
- "format": "date-time",
6242
6318
  "type": "string"
6243
6319
  },
6244
6320
  "versionInfo": {
@@ -6361,6 +6437,9 @@
6361
6437
  },
6362
6438
  "type": "object"
6363
6439
  },
6440
+ "Gone": {
6441
+ "type": "object"
6442
+ },
6364
6443
  "HTTPClientConfig": {
6365
6444
  "properties": {
6366
6445
  "authorization": {
@@ -6585,7 +6664,8 @@
6585
6664
  "folderId": {
6586
6665
  "description": "Deprecated: use FolderUID instead",
6587
6666
  "format": "int64",
6588
- "type": "integer"
6667
+ "type": "integer",
6668
+ "x-deprecated": true
6589
6669
  },
6590
6670
  "folderUid": {
6591
6671
  "type": "string"
@@ -6621,7 +6701,8 @@
6621
6701
  "folderId": {
6622
6702
  "description": "Deprecated: use FolderUID instead",
6623
6703
  "format": "int64",
6624
- "type": "integer"
6704
+ "type": "integer",
6705
+ "x-deprecated": true
6625
6706
  },
6626
6707
  "folderUid": {
6627
6708
  "type": "string"
@@ -6713,7 +6794,6 @@
6713
6794
  "properties": {
6714
6795
  "lastNotifyAttempt": {
6715
6796
  "description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
6716
- "format": "date-time",
6717
6797
  "type": "string"
6718
6798
  },
6719
6799
  "lastNotifyAttemptDuration": {
@@ -6794,7 +6874,7 @@
6794
6874
  "$ref": "#/components/schemas/URL"
6795
6875
  },
6796
6876
  "Key": {
6797
- "description": "Key is the Go in-memory representation of this key. It must have one\nof these types:\ned25519.PublicKey\ned25519.PrivateKey\necdsa.PublicKey\necdsa.PrivateKey\nrsa.PublicKey\nrsa.PrivateKey\n[]byte (a symmetric key)\n\nWhen marshaling this JSONWebKey into JSON, the \"kty\" header parameter\nwill be automatically set based on the type of this field."
6877
+ "description": "Key is the Go in-memory representation of this key. It must have one\nof these types:\n- ed25519.PublicKey\n- ed25519.PrivateKey\n- *ecdsa.PublicKey\n- *ecdsa.PrivateKey\n- *rsa.PublicKey\n- *rsa.PrivateKey\n- []byte (a symmetric key)\n\nWhen marshaling this JSONWebKey into JSON, the \"kty\" header parameter\nwill be automatically set based on the type of this field."
6798
6878
  },
6799
6879
  "KeyID": {
6800
6880
  "description": "Key identifier, parsed from `kid` header.",
@@ -6866,21 +6946,10 @@
6866
6946
  "format": "int64",
6867
6947
  "type": "integer"
6868
6948
  },
6869
- "Label": {
6870
- "properties": {
6871
- "Name": {
6872
- "type": "string"
6873
- }
6874
- },
6875
- "title": "Label is a key/value pair of strings.",
6876
- "type": "object"
6877
- },
6878
6949
  "Labels": {
6879
- "description": "Labels is a sorted set of labels. Order has to be guaranteed upon\ninstantiation.",
6880
- "items": {
6881
- "$ref": "#/components/schemas/Label"
6882
- },
6883
- "type": "array"
6950
+ "description": "Each name and value is preceded by its length, encoded as a single byte\nfor size 0-254, or the following 3 bytes little-endian, if the first byte is 255.\nMaximum length allowed is 2^24 or 16MB.\nNames are in order.",
6951
+ "title": "Labels is implemented by a single flat string holding name/value pairs.",
6952
+ "type": "object"
6884
6953
  },
6885
6954
  "LibraryElementArrayResponse": {
6886
6955
  "properties": {
@@ -6917,7 +6986,8 @@
6917
6986
  "id": {
6918
6987
  "description": "Deprecated: this field will be removed in the future",
6919
6988
  "format": "int64",
6920
- "type": "integer"
6989
+ "type": "integer",
6990
+ "x-deprecated": true
6921
6991
  },
6922
6992
  "kind": {
6923
6993
  "format": "int64",
@@ -6947,7 +7017,8 @@
6947
7017
  "folderId": {
6948
7018
  "description": "Deprecated: use FolderUID instead",
6949
7019
  "format": "int64",
6950
- "type": "integer"
7020
+ "type": "integer",
7021
+ "x-deprecated": true
6951
7022
  },
6952
7023
  "folderUid": {
6953
7024
  "type": "string"
@@ -6963,9 +7034,7 @@
6963
7034
  "meta": {
6964
7035
  "$ref": "#/components/schemas/LibraryElementDTOMeta"
6965
7036
  },
6966
- "model": {
6967
- "type": "object"
6968
- },
7037
+ "model": {},
6969
7038
  "name": {
6970
7039
  "type": "string"
6971
7040
  },
@@ -7145,7 +7214,7 @@
7145
7214
  "type": "object"
7146
7215
  },
7147
7216
  "ManagerKind": {
7148
- "description": "It can be a user or a tool or a generic API client.\n+enum",
7217
+ "description": "It can be a user or a tool or a generic API client.",
7149
7218
  "title": "ManagerKind is the type of manager, which is responsible for managing the resource.",
7150
7219
  "type": "string"
7151
7220
  },
@@ -7203,6 +7272,44 @@
7203
7272
  },
7204
7273
  "type": "array"
7205
7274
  },
7275
+ "MergeStats": {
7276
+ "properties": {
7277
+ "added_inhibition_rules": {
7278
+ "description": "AddedInhibitionRules contains the names of inhibition rules added",
7279
+ "items": {
7280
+ "type": "string"
7281
+ },
7282
+ "type": "array"
7283
+ },
7284
+ "added_receivers": {
7285
+ "description": "AddedReceivers contains the names of receivers added (post-rename if renamed)",
7286
+ "items": {
7287
+ "type": "string"
7288
+ },
7289
+ "type": "array"
7290
+ },
7291
+ "added_route": {
7292
+ "description": "AddedRoute is the identifier of the routing sub-tree added to the configuration",
7293
+ "type": "string"
7294
+ },
7295
+ "added_templates": {
7296
+ "description": "AddedTemplates contains the names of templates added",
7297
+ "items": {
7298
+ "type": "string"
7299
+ },
7300
+ "type": "array"
7301
+ },
7302
+ "added_time_intervals": {
7303
+ "description": "AddedTimeIntervals contains the names of time intervals added (post-rename if renamed)",
7304
+ "items": {
7305
+ "type": "string"
7306
+ },
7307
+ "type": "array"
7308
+ }
7309
+ },
7310
+ "title": "MergeStats describes which resources were added during configuration merge.",
7311
+ "type": "object"
7312
+ },
7206
7313
  "Metadata": {
7207
7314
  "additionalProperties": {
7208
7315
  "type": "boolean"
@@ -7380,6 +7487,9 @@
7380
7487
  "Name": {
7381
7488
  "description": "Name represents an X.509 distinguished name. This only includes the common\nelements of a DN. Note that Name is only an approximation of the X.509\nstructure. If an accurate representation is needed, asn1.Unmarshal the raw\nsubject or issuer as an [RDNSequence].",
7382
7489
  "properties": {
7490
+ "CommonName": {
7491
+ "type": "string"
7492
+ },
7383
7493
  "Country": {
7384
7494
  "items": {
7385
7495
  "type": "string"
@@ -7406,6 +7516,30 @@
7406
7516
  },
7407
7517
  "type": "array"
7408
7518
  },
7519
+ "Organization": {
7520
+ "items": {
7521
+ "type": "string"
7522
+ },
7523
+ "type": "array"
7524
+ },
7525
+ "OrganizationalUnit": {
7526
+ "items": {
7527
+ "type": "string"
7528
+ },
7529
+ "type": "array"
7530
+ },
7531
+ "PostalCode": {
7532
+ "items": {
7533
+ "type": "string"
7534
+ },
7535
+ "type": "array"
7536
+ },
7537
+ "Province": {
7538
+ "items": {
7539
+ "type": "string"
7540
+ },
7541
+ "type": "array"
7542
+ },
7409
7543
  "SerialNumber": {
7410
7544
  "type": "string"
7411
7545
  },
@@ -8002,21 +8136,21 @@
8002
8136
  "folderId": {
8003
8137
  "description": "ID of the folder where the library element is stored.\n\nDeprecated: use FolderUID instead",
8004
8138
  "format": "int64",
8005
- "type": "integer"
8139
+ "type": "integer",
8140
+ "x-deprecated": true
8006
8141
  },
8007
8142
  "folderUid": {
8008
8143
  "description": "UID of the folder where the library element is stored.",
8009
8144
  "type": "string"
8010
8145
  },
8011
8146
  "kind": {
8012
- "description": "Kind of element to create, Use 1 for library panels or 2 for c.\nDescription:\n1 - library panels",
8147
+ "description": "Kind of element to create, Use 1 for library panels or 2 for c.\nDescription:\n- 1 - library panels",
8013
8148
  "enum": [1],
8014
8149
  "format": "int64",
8015
8150
  "type": "integer"
8016
8151
  },
8017
8152
  "model": {
8018
- "description": "The JSON model for the library element.",
8019
- "type": "object"
8153
+ "description": "The JSON model for the library element."
8020
8154
  },
8021
8155
  "name": {
8022
8156
  "description": "Name of the library element.",
@@ -8037,7 +8171,7 @@
8037
8171
  "properties": {
8038
8172
  "homeDashboardId": {
8039
8173
  "default": 0,
8040
- "description": "The numerical :id of a favorited dashboard",
8174
+ "description": "The numerical :id of a favorited dashboard\nDeprecated: Use HomeDashboardUID instead",
8041
8175
  "format": "int64",
8042
8176
  "type": "integer"
8043
8177
  },
@@ -8100,10 +8234,6 @@
8100
8234
  "PermissionDenied": {
8101
8235
  "type": "object"
8102
8236
  },
8103
- "PermissionType": {
8104
- "format": "int64",
8105
- "type": "integer"
8106
- },
8107
8237
  "Playlist": {
8108
8238
  "description": "Playlist model",
8109
8239
  "properties": {
@@ -8215,7 +8345,7 @@
8215
8345
  "type": "string"
8216
8346
  },
8217
8347
  "value": {
8218
- "description": "Value depends on type and describes the playlist item.\n\ndashboard_by_id: The value is an internal numerical identifier set by Grafana. This\nis not portable as the numerical identifier is non-deterministic between different instances.\nWill be replaced by dashboard_by_uid in the future. (deprecated)\ndashboard_by_tag: The value is a tag which is set on any number of dashboards. All\ndashboards behind the tag will be added to the playlist.\ndashboard_by_uid: The value is the dashboard UID",
8348
+ "description": "Value depends on type and describes the playlist item.\n\n- dashboard_by_id: The value is an internal numerical identifier set by Grafana. This\nis not portable as the numerical identifier is non-deterministic between different instances.\nWill be replaced by dashboard_by_uid in the future. (deprecated)\n- dashboard_by_tag: The value is a tag which is set on any number of dashboards. All\ndashboards behind the tag will be added to the playlist.\n- dashboard_by_uid: The value is the dashboard UID",
8219
8349
  "type": "string"
8220
8350
  }
8221
8351
  },
@@ -8341,105 +8471,14 @@
8341
8471
  "PostableApiReceiver": {
8342
8472
  "description": "nolint:revive",
8343
8473
  "properties": {
8344
- "discord_configs": {
8345
- "items": {
8346
- "$ref": "#/components/schemas/DiscordConfig"
8347
- },
8348
- "type": "array"
8349
- },
8350
- "email_configs": {
8351
- "items": {
8352
- "$ref": "#/components/schemas/EmailConfig"
8353
- },
8354
- "type": "array"
8355
- },
8356
8474
  "grafana_managed_receiver_configs": {
8357
8475
  "items": {
8358
8476
  "$ref": "#/components/schemas/PostableGrafanaReceiver"
8359
8477
  },
8360
8478
  "type": "array"
8361
8479
  },
8362
- "jira_configs": {
8363
- "items": {
8364
- "$ref": "#/components/schemas/JiraConfig"
8365
- },
8366
- "type": "array"
8367
- },
8368
- "msteams_configs": {
8369
- "items": {
8370
- "$ref": "#/components/schemas/MSTeamsConfig"
8371
- },
8372
- "type": "array"
8373
- },
8374
- "msteamsv2_configs": {
8375
- "items": {
8376
- "$ref": "#/components/schemas/MSTeamsV2Config"
8377
- },
8378
- "type": "array"
8379
- },
8380
8480
  "name": {
8381
- "description": "A unique identifier for this receiver.",
8382
8481
  "type": "string"
8383
- },
8384
- "opsgenie_configs": {
8385
- "items": {
8386
- "$ref": "#/components/schemas/OpsGenieConfig"
8387
- },
8388
- "type": "array"
8389
- },
8390
- "pagerduty_configs": {
8391
- "items": {
8392
- "$ref": "#/components/schemas/PagerdutyConfig"
8393
- },
8394
- "type": "array"
8395
- },
8396
- "pushover_configs": {
8397
- "items": {
8398
- "$ref": "#/components/schemas/PushoverConfig"
8399
- },
8400
- "type": "array"
8401
- },
8402
- "slack_configs": {
8403
- "items": {
8404
- "$ref": "#/components/schemas/SlackConfig"
8405
- },
8406
- "type": "array"
8407
- },
8408
- "sns_configs": {
8409
- "items": {
8410
- "$ref": "#/components/schemas/SNSConfig"
8411
- },
8412
- "type": "array"
8413
- },
8414
- "telegram_configs": {
8415
- "items": {
8416
- "$ref": "#/components/schemas/TelegramConfig"
8417
- },
8418
- "type": "array"
8419
- },
8420
- "victorops_configs": {
8421
- "items": {
8422
- "$ref": "#/components/schemas/VictorOpsConfig"
8423
- },
8424
- "type": "array"
8425
- },
8426
- "webex_configs": {
8427
- "items": {
8428
- "$ref": "#/components/schemas/WebexConfig"
8429
- },
8430
- "type": "array"
8431
- },
8432
- "webhook_configs": {
8433
- "items": {
8434
- "$ref": "#/components/schemas/WebhookConfig"
8435
- },
8436
- "type": "array"
8437
- },
8438
- "wechat_configs": {
8439
- "items": {
8440
- "$ref": "#/components/schemas/WechatConfig"
8441
- },
8442
- "type": "array"
8443
8482
  }
8444
8483
  },
8445
8484
  "type": "object"
@@ -8522,6 +8561,9 @@
8522
8561
  },
8523
8562
  "uid": {
8524
8563
  "type": "string"
8564
+ },
8565
+ "version": {
8566
+ "type": "string"
8525
8567
  }
8526
8568
  },
8527
8569
  "type": "object"
@@ -8588,6 +8630,10 @@
8588
8630
  "alertmanagersChoice": {
8589
8631
  "enum": ["all", "internal", "external"],
8590
8632
  "type": "string"
8633
+ },
8634
+ "external_alertmanager_uid": {
8635
+ "description": "ExternalAlertmanagerUID is the UID of the Mimir/Cortex Alertmanager datasource to sync\nconfiguration from. Empty string disables sync for this org.",
8636
+ "type": "string"
8591
8637
  }
8592
8638
  },
8593
8639
  "type": "object"
@@ -8640,28 +8686,7 @@
8640
8686
  },
8641
8687
  "type": "object"
8642
8688
  },
8643
- "PostableUserConfig": {
8644
- "properties": {
8645
- "alertmanager_config": {
8646
- "$ref": "#/components/schemas/PostableApiAlertingConfig"
8647
- },
8648
- "extra_config": {
8649
- "items": {
8650
- "$ref": "#/components/schemas/ExtraConfiguration"
8651
- },
8652
- "type": "array"
8653
- },
8654
- "template_files": {
8655
- "additionalProperties": {
8656
- "type": "string"
8657
- },
8658
- "type": "object"
8659
- }
8660
- },
8661
- "type": "object"
8662
- },
8663
8689
  "PreferencesNavbarPreference": {
8664
- "description": "+k8s:openapi-gen=true",
8665
8690
  "properties": {
8666
8691
  "bookmarkUrls": {
8667
8692
  "items": {
@@ -8673,7 +8698,6 @@
8673
8698
  "type": "object"
8674
8699
  },
8675
8700
  "PreferencesQueryHistoryPreference": {
8676
- "description": "+k8s:openapi-gen=true",
8677
8701
  "properties": {
8678
8702
  "homeTab": {
8679
8703
  "description": "one of: '' | 'query' | 'starred';",
@@ -8683,10 +8707,9 @@
8683
8707
  "type": "object"
8684
8708
  },
8685
8709
  "PreferencesSpec": {
8686
- "description": "+k8s:openapi-gen=true",
8687
8710
  "properties": {
8688
8711
  "homeDashboardUID": {
8689
- "description": "UID for the home dashboard",
8712
+ "description": "UID for the home dashboard. The reserved value \"global-home\" is not a\ndashboard UID: it selects the instance default home (home_page, the\nconfigured home dashboard file, or the built-in home page) instead of\nfalling through to lower-precedence preferences.",
8690
8713
  "type": "string"
8691
8714
  },
8692
8715
  "homeURL": {
@@ -9645,6 +9668,26 @@
9645
9668
  },
9646
9669
  "type": "object"
9647
9670
  },
9671
+ "RenameResources": {
9672
+ "description": "RenameResources describes which resources were renamed to avoid conflicts",
9673
+ "properties": {
9674
+ "receivers": {
9675
+ "additionalProperties": {
9676
+ "type": "string"
9677
+ },
9678
+ "description": "Receivers maps old receiver names to new receiver names",
9679
+ "type": "object"
9680
+ },
9681
+ "time_intervals": {
9682
+ "additionalProperties": {
9683
+ "type": "string"
9684
+ },
9685
+ "description": "TimeIntervals maps old time interval names to new time interval names",
9686
+ "type": "object"
9687
+ }
9688
+ },
9689
+ "type": "object"
9690
+ },
9648
9691
  "Report": {
9649
9692
  "properties": {
9650
9693
  "created": {
@@ -9750,9 +9793,7 @@
9750
9793
  "dashboard": {
9751
9794
  "$ref": "#/components/schemas/ReportDashboardID"
9752
9795
  },
9753
- "reportVariables": {
9754
- "type": "object"
9755
- },
9796
+ "reportVariables": {},
9756
9797
  "timeRange": {
9757
9798
  "$ref": "#/components/schemas/ReportTimeRange"
9758
9799
  }
@@ -9781,10 +9822,14 @@
9781
9822
  "type": "string"
9782
9823
  },
9783
9824
  "id": {
9784
- "description": "Send the report to the emails specified in the report. Required if emails is not present.",
9825
+ "description": "Numeric ID of the report. Can send either ID or UID. If both are present, UID takes precedence.",
9785
9826
  "format": "int64",
9786
9827
  "type": "string"
9787
9828
  },
9829
+ "uid": {
9830
+ "description": "UID of the report. Can send either ID or UID. If both are present, UID takes precedence.",
9831
+ "type": "string"
9832
+ },
9788
9833
  "useEmailsFromReport": {
9789
9834
  "description": "Send the report to the emails specified in the report. Required if emails is not present.",
9790
9835
  "type": "boolean"
@@ -10488,7 +10533,8 @@
10488
10533
  "folderId": {
10489
10534
  "description": "Deprecated: use FolderUID instead",
10490
10535
  "format": "int64",
10491
- "type": "integer"
10536
+ "type": "integer",
10537
+ "x-deprecated": true
10492
10538
  },
10493
10539
  "folderUid": {
10494
10540
  "type": "string"
@@ -10533,7 +10579,6 @@
10533
10579
  "type": "object"
10534
10580
  },
10535
10581
  "SearchOrgServiceAccountsResult": {
10536
- "description": "swagger: model",
10537
10582
  "properties": {
10538
10583
  "page": {
10539
10584
  "format": "int64",
@@ -10657,7 +10702,6 @@
10657
10702
  "$ref": "#/components/schemas/URL"
10658
10703
  },
10659
10704
  "ServiceAccountDTO": {
10660
- "description": "swagger: model",
10661
10705
  "properties": {
10662
10706
  "accessControl": {
10663
10707
  "additionalProperties": {
@@ -11173,7 +11217,6 @@
11173
11217
  "type": "object"
11174
11218
  },
11175
11219
  "State": {
11176
- "description": "+enum",
11177
11220
  "type": "string"
11178
11221
  },
11179
11222
  "Status": {
@@ -11336,7 +11379,7 @@
11336
11379
  "type": "integer"
11337
11380
  },
11338
11381
  "permission": {
11339
- "$ref": "#/components/schemas/PermissionType"
11382
+ "$ref": "#/components/schemas/TeamPermissionType"
11340
11383
  },
11341
11384
  "uid": {
11342
11385
  "type": "string"
@@ -11363,12 +11406,14 @@
11363
11406
  },
11364
11407
  "uid": {
11365
11408
  "description": "Deprecated: always empty; no per-entry id.",
11366
- "type": "string"
11409
+ "type": "string",
11410
+ "x-deprecated": true
11367
11411
  }
11368
11412
  },
11369
11413
  "type": "object"
11370
11414
  },
11371
11415
  "TeamGroupMapping": {
11416
+ "description": "---------------------",
11372
11417
  "properties": {
11373
11418
  "groupId": {
11374
11419
  "type": "string"
@@ -11432,7 +11477,7 @@
11432
11477
  "type": "integer"
11433
11478
  },
11434
11479
  "permission": {
11435
- "$ref": "#/components/schemas/PermissionType"
11480
+ "$ref": "#/components/schemas/TeamPermissionType"
11436
11481
  },
11437
11482
  "teamId": {
11438
11483
  "format": "int64",
@@ -11454,6 +11499,10 @@
11454
11499
  },
11455
11500
  "type": "object"
11456
11501
  },
11502
+ "TeamPermissionType": {
11503
+ "format": "int64",
11504
+ "type": "integer"
11505
+ },
11457
11506
  "TelegramConfig": {
11458
11507
  "properties": {
11459
11508
  "api_url": {
@@ -11543,6 +11592,9 @@
11543
11592
  "TempUserStatus": {
11544
11593
  "type": "string"
11545
11594
  },
11595
+ "TemplateKind": {
11596
+ "type": "string"
11597
+ },
11546
11598
  "TestRulePayload": {
11547
11599
  "properties": {
11548
11600
  "expr": {
@@ -11575,6 +11627,9 @@
11575
11627
  },
11576
11628
  "type": "array"
11577
11629
  },
11630
+ "kind": {
11631
+ "$ref": "#/components/schemas/TemplateKind"
11632
+ },
11578
11633
  "name": {
11579
11634
  "description": "Name of the template file.",
11580
11635
  "type": "string"
@@ -11914,22 +11969,20 @@
11914
11969
  "type": "array"
11915
11970
  },
11916
11971
  "Type": {
11917
- "description": "+enum",
11918
11972
  "type": "string"
11919
11973
  },
11920
11974
  "TypeMeta": {
11921
- "description": "+k8s:deepcopy-gen=false",
11975
+ "description": "TypeMeta describes an individual object in an API response or request\nwith strings representing the type of the object and its API schema version.\nStructures that are versioned or persisted should inline TypeMeta.",
11922
11976
  "properties": {
11923
11977
  "apiVersion": {
11924
- "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional",
11978
+ "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
11925
11979
  "type": "string"
11926
11980
  },
11927
11981
  "kind": {
11928
- "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional",
11982
+ "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
11929
11983
  "type": "string"
11930
11984
  }
11931
11985
  },
11932
- "title": "TypeMeta describes an individual object in an API response or request\nwith strings representing the type of the object and its API schema version.\nStructures that are versioned or persisted should inline TypeMeta.",
11933
11986
  "type": "object"
11934
11987
  },
11935
11988
  "URL": {
@@ -12177,7 +12230,7 @@
12177
12230
  "properties": {
12178
12231
  "homeDashboardId": {
12179
12232
  "default": 0,
12180
- "description": "The numerical :id of a favorited dashboard",
12233
+ "description": "The numerical :id of a favorited dashboard\nDeprecated: Use HomeDashboardUID instead",
12181
12234
  "format": "int64",
12182
12235
  "type": "integer"
12183
12236
  },
@@ -12319,7 +12372,7 @@
12319
12372
  "UpdateTeamMemberCommand": {
12320
12373
  "properties": {
12321
12374
  "permission": {
12322
- "$ref": "#/components/schemas/PermissionType"
12375
+ "$ref": "#/components/schemas/TeamPermissionType"
12323
12376
  }
12324
12377
  },
12325
12378
  "type": "object"
@@ -12738,7 +12791,6 @@
12738
12791
  "properties": {
12739
12792
  "generatorURL": {
12740
12793
  "description": "generator URL\nFormat: uri",
12741
- "format": "uri",
12742
12794
  "type": "string"
12743
12795
  },
12744
12796
  "labels": {
@@ -12823,7 +12875,6 @@
12823
12875
  },
12824
12876
  "uptime": {
12825
12877
  "description": "uptime",
12826
- "format": "date-time",
12827
12878
  "type": "string"
12828
12879
  },
12829
12880
  "versionInfo": {
@@ -12892,7 +12943,6 @@
12892
12943
  },
12893
12944
  "endsAt": {
12894
12945
  "description": "ends at",
12895
- "format": "date-time",
12896
12946
  "type": "string"
12897
12947
  },
12898
12948
  "fingerprint": {
@@ -12901,7 +12951,6 @@
12901
12951
  },
12902
12952
  "generatorURL": {
12903
12953
  "description": "generator URL\nFormat: uri",
12904
- "format": "uri",
12905
12954
  "type": "string"
12906
12955
  },
12907
12956
  "labels": {
@@ -12916,7 +12965,6 @@
12916
12965
  },
12917
12966
  "startsAt": {
12918
12967
  "description": "starts at",
12919
- "format": "date-time",
12920
12968
  "type": "string"
12921
12969
  },
12922
12970
  "status": {
@@ -12924,7 +12972,6 @@
12924
12972
  },
12925
12973
  "updatedAt": {
12926
12974
  "description": "updated at",
12927
- "format": "date-time",
12928
12975
  "type": "string"
12929
12976
  }
12930
12977
  },
@@ -12961,7 +13008,6 @@
12961
13008
  },
12962
13009
  "endsAt": {
12963
13010
  "description": "ends at",
12964
- "format": "date-time",
12965
13011
  "type": "string"
12966
13012
  },
12967
13013
  "id": {
@@ -12976,7 +13022,6 @@
12976
13022
  },
12977
13023
  "startsAt": {
12978
13024
  "description": "starts at",
12979
- "format": "date-time",
12980
13025
  "type": "string"
12981
13026
  },
12982
13027
  "status": {
@@ -12984,7 +13029,6 @@
12984
13029
  },
12985
13030
  "updatedAt": {
12986
13031
  "description": "updated at",
12987
- "format": "date-time",
12988
13032
  "type": "string"
12989
13033
  }
12990
13034
  },
@@ -13010,7 +13054,6 @@
13010
13054
  },
13011
13055
  "endsAt": {
13012
13056
  "description": "ends at",
13013
- "format": "date-time",
13014
13057
  "type": "string"
13015
13058
  },
13016
13059
  "id": {
@@ -13022,7 +13065,6 @@
13022
13065
  },
13023
13066
  "startsAt": {
13024
13067
  "description": "starts at",
13025
- "format": "date-time",
13026
13068
  "type": "string"
13027
13069
  },
13028
13070
  "status": {
@@ -13030,7 +13072,6 @@
13030
13072
  },
13031
13073
  "updatedAt": {
13032
13074
  "description": "updated at",
13033
- "format": "date-time",
13034
13075
  "type": "string"
13035
13076
  }
13036
13077
  },
@@ -13133,12 +13174,10 @@
13133
13174
  },
13134
13175
  "endsAt": {
13135
13176
  "description": "ends at\nFormat: date-time",
13136
- "format": "date-time",
13137
13177
  "type": "string"
13138
13178
  },
13139
13179
  "generatorURL": {
13140
13180
  "description": "generator URL\nFormat: uri",
13141
- "format": "uri",
13142
13181
  "type": "string"
13143
13182
  },
13144
13183
  "labels": {
@@ -13146,7 +13185,6 @@
13146
13185
  },
13147
13186
  "startsAt": {
13148
13187
  "description": "starts at\nFormat: date-time",
13149
- "format": "date-time",
13150
13188
  "type": "string"
13151
13189
  }
13152
13190
  },
@@ -13173,7 +13211,6 @@
13173
13211
  },
13174
13212
  "endsAt": {
13175
13213
  "description": "ends at",
13176
- "format": "date-time",
13177
13214
  "type": "string"
13178
13215
  },
13179
13216
  "id": {
@@ -13185,7 +13222,6 @@
13185
13222
  },
13186
13223
  "startsAt": {
13187
13224
  "description": "starts at",
13188
- "format": "date-time",
13189
13225
  "type": "string"
13190
13226
  }
13191
13227
  },
@@ -13319,7 +13355,6 @@
13319
13355
  },
13320
13356
  "endsAt": {
13321
13357
  "description": "ends at",
13322
- "format": "date-time",
13323
13358
  "type": "string"
13324
13359
  },
13325
13360
  "matchers": {
@@ -13327,7 +13362,6 @@
13327
13362
  },
13328
13363
  "startsAt": {
13329
13364
  "description": "starts at",
13330
- "format": "date-time",
13331
13365
  "type": "string"
13332
13366
  }
13333
13367
  },
@@ -13478,7 +13512,7 @@
13478
13512
  },
13479
13513
  "/access-control/roles/{roleUID}": {
13480
13514
  "delete": {
13481
- "description": "Delete a role with the given UID, and it’s permissions. If the role is assigned to a built-in role, the deletion operation will fail, unless force query param is set to true, and in that case all assignments will also be deleted.\n\nYou need to have a permission with action `roles:delete` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only delete a custom role with the same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to delete a custom role which allows to do that.",
13515
+ "description": "Delete a role with the given UID, and it’s permissions. If the role is assigned to a built-in role, the deletion operation will fail, unless force query param is set to true, and in that case all assignments will also be deleted.\n\nYou need to have a permission with action `roles:delete` and scope `permissions:type:delegate`.",
13482
13516
  "operationId": "deleteRole",
13483
13517
  "parameters": [
13484
13518
  {
@@ -13549,7 +13583,7 @@
13549
13583
  "tags": ["access_control", "enterprise"]
13550
13584
  },
13551
13585
  "put": {
13552
- "description": "You need to have a permission with action `roles:write` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only create custom roles with the same, or a subset of permissions which the user has.",
13586
+ "description": "You need to have a permission with action `roles:write` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only update custom roles with permissions which the user has.",
13553
13587
  "operationId": "updateRole",
13554
13588
  "parameters": [
13555
13589
  {
@@ -13807,7 +13841,7 @@
13807
13841
  "tags": ["access_control", "enterprise"]
13808
13842
  },
13809
13843
  "put": {
13810
- "description": "You need to have a permission with action `teams.roles:add` and `teams.roles:remove` and scope `permissions:type:delegate` for each.",
13844
+ "description": "You need to have a permission with action `teams.roles:add` and `teams.roles:remove` and scope `permissions:type:delegate` for each. The delegate scope is required for permissions on roles being added.",
13811
13845
  "operationId": "setTeamRoles",
13812
13846
  "parameters": [
13813
13847
  {
@@ -14027,7 +14061,7 @@
14027
14061
  "tags": ["access_control", "enterprise"]
14028
14062
  },
14029
14063
  "put": {
14030
- "description": "Update the user’s role assignments to match the provided set of UIDs. This will remove any assigned roles that aren’t in the request and add roles that are in the set but are not already assigned to the user.\nRoles mapped through group attribute sync are not impacted.\nIf you want to add or remove a single role, consider using Add a user role assignment or Remove a user role assignment instead.\n\nYou need to have a permission with action `users.roles:add` and `users.roles:remove` and scope `permissions:type:delegate` for each. `permissions:type:delegate` scope ensures that users can only assign or unassign roles which have same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to assign or unassign a role which will allow to do that. This is done to prevent escalation of privileges.",
14064
+ "description": "Update the user’s role assignments to match the provided set of UIDs. This will remove any assigned roles that aren’t in the request and add roles that are in the set but are not already assigned to the user.\nRoles mapped through group attribute sync are not impacted.\nIf you want to add or remove a single role, consider using Add a user role assignment or Remove a user role assignment instead.\n\nYou need to have a permission with action `users.roles:add` and `users.roles:remove` and scope `permissions:type:delegate` for each. The delegate scope is required for permissions on roles being added.",
14031
14065
  "operationId": "setUserRoles",
14032
14066
  "parameters": [
14033
14067
  {
@@ -14082,7 +14116,7 @@
14082
14116
  },
14083
14117
  "/access-control/users/{userId}/roles/{roleUID}": {
14084
14118
  "delete": {
14085
- "description": "Revoke a role from a user. For bulk updates consider Set user role assignments.\n\nYou need to have a permission with action `users.roles:remove` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only unassign roles which have same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to unassign a role which will allow to do that. This is done to prevent escalation of privileges.",
14119
+ "description": "Revoke a role from a user. For bulk updates consider Set user role assignments.\n\nYou need to have a permission with action `users.roles:remove` and scope `permissions:type:delegate`.",
14086
14120
  "operationId": "removeUserRole",
14087
14121
  "parameters": [
14088
14122
  {
@@ -15324,6 +15358,7 @@
15324
15358
  },
15325
15359
  {
15326
15360
  "description": "Use this to filter organization annotations. Organization annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. You can filter by multiple tags.",
15361
+ "explode": true,
15327
15362
  "in": "query",
15328
15363
  "name": "tags",
15329
15364
  "schema": {
@@ -15331,10 +15366,11 @@
15331
15366
  "type": "string"
15332
15367
  },
15333
15368
  "type": "array"
15334
- }
15369
+ },
15370
+ "style": "form"
15335
15371
  },
15336
15372
  {
15337
- "description": "Return alerts or user created annotations",
15373
+ "description": "Return alerts or user created annotations\nDescription:\n- `alert`\n- `annotation`",
15338
15374
  "in": "query",
15339
15375
  "name": "type",
15340
15376
  "schema": {
@@ -17375,6 +17411,7 @@
17375
17411
  "operationId": "updateDashboardPermissionsByUID",
17376
17412
  "parameters": [
17377
17413
  {
17414
+ "description": "The dashboard UID",
17378
17415
  "in": "path",
17379
17416
  "name": "uid",
17380
17417
  "required": true,
@@ -17650,6 +17687,7 @@
17650
17687
  },
17651
17688
  {
17652
17689
  "description": "Source datasource UID filter to be applied to correlations",
17690
+ "explode": true,
17653
17691
  "in": "query",
17654
17692
  "name": "sourceUID",
17655
17693
  "schema": {
@@ -17657,7 +17695,8 @@
17657
17695
  "type": "string"
17658
17696
  },
17659
17697
  "type": "array"
17660
- }
17698
+ },
17699
+ "style": "form"
17661
17700
  }
17662
17701
  ],
17663
17702
  "responses": {
@@ -18428,6 +18467,7 @@
18428
18467
  }
18429
18468
  },
18430
18469
  {
18470
+ "description": "Optional datasource type used to disambiguate datasource UID lookups.",
18431
18471
  "in": "query",
18432
18472
  "name": "dataSourceType",
18433
18473
  "schema": {
@@ -18444,7 +18484,7 @@
18444
18484
  }
18445
18485
  }
18446
18486
  },
18447
- "description": "CacheConfigResponse"
18487
+ "description": "OK"
18448
18488
  },
18449
18489
  "500": {
18450
18490
  "$ref": "#/components/responses/internalServerError"
@@ -18465,6 +18505,7 @@
18465
18505
  }
18466
18506
  },
18467
18507
  {
18508
+ "description": "Optional datasource type used to disambiguate datasource UID lookups.",
18468
18509
  "in": "query",
18469
18510
  "name": "dataSourceType",
18470
18511
  "schema": {
@@ -18492,7 +18533,7 @@
18492
18533
  }
18493
18534
  }
18494
18535
  },
18495
- "description": "CacheConfigResponse"
18536
+ "description": "OK"
18496
18537
  },
18497
18538
  "400": {
18498
18539
  "$ref": "#/components/responses/badRequestError"
@@ -18527,7 +18568,7 @@
18527
18568
  }
18528
18569
  }
18529
18570
  },
18530
- "description": "CacheConfigResponse"
18571
+ "description": "OK"
18531
18572
  },
18532
18573
  "500": {
18533
18574
  "$ref": "#/components/responses/internalServerError"
@@ -18550,6 +18591,7 @@
18550
18591
  }
18551
18592
  },
18552
18593
  {
18594
+ "description": "Optional datasource type used to disambiguate datasource UID lookups.",
18553
18595
  "in": "query",
18554
18596
  "name": "dataSourceType",
18555
18597
  "schema": {
@@ -18566,7 +18608,7 @@
18566
18608
  }
18567
18609
  }
18568
18610
  },
18569
- "description": "CacheConfigResponse"
18611
+ "description": "OK"
18570
18612
  },
18571
18613
  "500": {
18572
18614
  "$ref": "#/components/responses/internalServerError"
@@ -18589,6 +18631,7 @@
18589
18631
  }
18590
18632
  },
18591
18633
  {
18634
+ "description": "Optional datasource type used to disambiguate datasource UID lookups.",
18592
18635
  "in": "query",
18593
18636
  "name": "dataSourceType",
18594
18637
  "schema": {
@@ -18605,7 +18648,7 @@
18605
18648
  }
18606
18649
  }
18607
18650
  },
18608
- "description": "CacheConfigResponse"
18651
+ "description": "OK"
18609
18652
  },
18610
18653
  "500": {
18611
18654
  "$ref": "#/components/responses/internalServerError"
@@ -19062,7 +19105,7 @@
19062
19105
  }
19063
19106
  }
19064
19107
  },
19065
- "description": "healthResponse"
19108
+ "description": "OK"
19066
19109
  },
19067
19110
  "503": {
19068
19111
  "$ref": "#/components/responses/internalServerError"
@@ -19085,7 +19128,7 @@
19085
19128
  }
19086
19129
  },
19087
19130
  {
19088
- "description": "Kind of element to search for.",
19131
+ "description": "Kind of element to search for.\nDescription:\n- 1 - library panels",
19089
19132
  "in": "query",
19090
19133
  "name": "kind",
19091
19134
  "schema": {
@@ -19095,7 +19138,7 @@
19095
19138
  }
19096
19139
  },
19097
19140
  {
19098
- "description": "Sort order of elements.",
19141
+ "description": "Sort order of elements.\nDescription:\n- alpha-asc: ascending\n- alpha-desc: descending",
19099
19142
  "in": "query",
19100
19143
  "name": "sortDirection",
19101
19144
  "schema": {
@@ -19411,7 +19454,7 @@
19411
19454
  "/licensing/custom-permissions": {
19412
19455
  "get": {
19413
19456
  "deprecated": true,
19414
- "description": "You need to have a permission with action `licensing.reports:read`.",
19457
+ "description": "You need to have a permission with action `licensing.reports:read`.\n\nDeprecated. There is currently no replacement for this endpoint. Please reach out to Grafana support if you rely on this endpoint.",
19415
19458
  "operationId": "getCustomPermissionsReport",
19416
19459
  "responses": {
19417
19460
  "500": {
@@ -19425,7 +19468,7 @@
19425
19468
  "/licensing/custom-permissions-csv": {
19426
19469
  "get": {
19427
19470
  "deprecated": true,
19428
- "description": "You need to have a permission with action `licensing.reports:read`.",
19471
+ "description": "You need to have a permission with action `licensing.reports:read`.\n\nDeprecated. There is currently no replacement for this endpoint. Please reach out to Grafana support if you rely on this endpoint.",
19429
19472
  "operationId": "getCustomPermissionsCSV",
19430
19473
  "responses": {
19431
19474
  "500": {
@@ -20698,7 +20741,6 @@
20698
20741
  }
20699
20742
  },
20700
20743
  {
20701
- "description": "in:limit",
20702
20744
  "in": "query",
20703
20745
  "name": "limit",
20704
20746
  "schema": {
@@ -21032,6 +21074,7 @@
21032
21074
  "parameters": [
21033
21075
  {
21034
21076
  "description": "List of data source UIDs to search for",
21077
+ "explode": true,
21035
21078
  "in": "query",
21036
21079
  "name": "datasourceUid",
21037
21080
  "schema": {
@@ -21039,7 +21082,8 @@
21039
21082
  "type": "string"
21040
21083
  },
21041
21084
  "type": "array"
21042
- }
21085
+ },
21086
+ "style": "form"
21043
21087
  },
21044
21088
  {
21045
21089
  "description": "Text inside query or comments that is searched for",
@@ -22117,6 +22161,7 @@
22117
22161
  },
22118
22162
  {
22119
22163
  "description": "List of tags to search for",
22164
+ "explode": true,
22120
22165
  "in": "query",
22121
22166
  "name": "tag",
22122
22167
  "schema": {
@@ -22124,10 +22169,11 @@
22124
22169
  "type": "string"
22125
22170
  },
22126
22171
  "type": "array"
22127
- }
22172
+ },
22173
+ "style": "form"
22128
22174
  },
22129
22175
  {
22130
- "description": "Type to search for, dash-folder or dash-db",
22176
+ "description": "Type to search for, dash-folder or dash-db\nDescription:\n- `dash-folder` - Search for folder\n- `dash-db` - Seatch for dashboard",
22131
22177
  "in": "query",
22132
22178
  "name": "type",
22133
22179
  "schema": {
@@ -22159,7 +22205,7 @@
22159
22205
  }
22160
22206
  },
22161
22207
  {
22162
- "description": "List of folder id’s to search in for dashboards\nIf it's `0` then it will query for the top level folders\nThis is deprecated: users should use the `folderUIDs` query parameter instead",
22208
+ "description": "List of folder id’s to search in for dashboards\nIf it's `0` then it will query for the top level folders\nThis is deprecated: users should use the `folderUIDs` query parameter instead\n\nDeprecated: use FolderUIDs instead",
22163
22209
  "in": "query",
22164
22210
  "name": "folderIds",
22165
22211
  "schema": {
@@ -23707,7 +23753,7 @@
23707
23753
  },
23708
23754
  "put": {
23709
23755
  "deprecated": true,
23710
- "description": "Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}",
23756
+ "description": "Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}\n\n\nOmitting a key (`theme`, `homeDashboardUID`, `timezone`) will cause the current value to be replaced with the system default value.",
23711
23757
  "operationId": "updateUserPreferences",
23712
23758
  "requestBody": {
23713
23759
  "content": {
@@ -23800,7 +23846,8 @@
23800
23846
  },
23801
23847
  "/user/stars/dashboard/uid/{dashboard_uid}": {
23802
23848
  "delete": {
23803
- "description": "Deletes the starring of the given Dashboard for the actual user.",
23849
+ "deprecated": true,
23850
+ "description": "Deletes the starring of the given Dashboard for the actual user.\n\nUse: DELETE /apis/collections.grafana.app/v1alpha1/namespaces/{namespace}/stars/{name}/update/{group}/{kind}/{id}",
23804
23851
  "operationId": "unstarDashboardByUID",
23805
23852
  "parameters": [
23806
23853
  {
@@ -23833,7 +23880,8 @@
23833
23880
  "tags": ["signed_in_user"]
23834
23881
  },
23835
23882
  "post": {
23836
- "description": "Stars the given Dashboard for the actual user.",
23883
+ "deprecated": true,
23884
+ "description": "Stars the given Dashboard for the actual user.\n\nUse: PUT /apis/collections.grafana.app/v1alpha1/namespaces/{namespace}/stars/{name}/update/{group}/{kind}/{id}",
23837
23885
  "operationId": "starDashboardByUID",
23838
23886
  "parameters": [
23839
23887
  {
@@ -24732,6 +24780,16 @@
24732
24780
  }
24733
24781
  },
24734
24782
  "description": "ForbiddenError"
24783
+ },
24784
+ "409": {
24785
+ "content": {
24786
+ "application/json": {
24787
+ "schema": {
24788
+ "$ref": "#/components/schemas/PublicError"
24789
+ }
24790
+ }
24791
+ },
24792
+ "description": "PublicError"
24735
24793
  }
24736
24794
  },
24737
24795
  "summary": "Create a contact point.",
@@ -24873,6 +24931,16 @@
24873
24931
  }
24874
24932
  },
24875
24933
  "description": "ForbiddenError"
24934
+ },
24935
+ "409": {
24936
+ "content": {
24937
+ "application/json": {
24938
+ "schema": {
24939
+ "$ref": "#/components/schemas/PublicError"
24940
+ }
24941
+ }
24942
+ },
24943
+ "description": "PublicError"
24876
24944
  }
24877
24945
  },
24878
24946
  "summary": "Delete a contact point.",
@@ -24939,6 +25007,16 @@
24939
25007
  }
24940
25008
  },
24941
25009
  "description": "ForbiddenError"
25010
+ },
25011
+ "409": {
25012
+ "content": {
25013
+ "application/json": {
25014
+ "schema": {
25015
+ "$ref": "#/components/schemas/PublicError"
25016
+ }
25017
+ }
25018
+ },
25019
+ "description": "PublicError"
24942
25020
  }
24943
25021
  },
24944
25022
  "summary": "Update an existing contact point.",
@@ -25308,6 +25386,16 @@
25308
25386
  }
25309
25387
  },
25310
25388
  "description": "ForbiddenError"
25389
+ },
25390
+ "409": {
25391
+ "content": {
25392
+ "application/json": {
25393
+ "schema": {
25394
+ "$ref": "#/components/schemas/PublicError"
25395
+ }
25396
+ }
25397
+ },
25398
+ "description": "PublicError"
25311
25399
  }
25312
25400
  },
25313
25401
  "summary": "Create a new mute timing.",
@@ -25704,6 +25792,16 @@
25704
25792
  }
25705
25793
  },
25706
25794
  "description": "ForbiddenError"
25795
+ },
25796
+ "409": {
25797
+ "content": {
25798
+ "application/json": {
25799
+ "schema": {
25800
+ "$ref": "#/components/schemas/PublicError"
25801
+ }
25802
+ }
25803
+ },
25804
+ "description": "PublicError"
25707
25805
  }
25708
25806
  },
25709
25807
  "summary": "Clears the notification policy tree.",
@@ -25790,6 +25888,16 @@
25790
25888
  }
25791
25889
  },
25792
25890
  "description": "ForbiddenError"
25891
+ },
25892
+ "409": {
25893
+ "content": {
25894
+ "application/json": {
25895
+ "schema": {
25896
+ "$ref": "#/components/schemas/PublicError"
25897
+ }
25898
+ }
25899
+ },
25900
+ "description": "PublicError"
25793
25901
  }
25794
25902
  },
25795
25903
  "summary": "Sets the notification policy tree.",
@@ -26311,6 +26419,9 @@
26311
26419
  }
26312
26420
  ],
26313
26421
  "servers": [
26422
+ {
26423
+ "url": "/api"
26424
+ },
26314
26425
  {
26315
26426
  "url": "/api"
26316
26427
  }