@grafana/openapi 13.1.0-25858739282 → 13.1.0-26657291204
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 +5 -10
- package/dist/apis/folder.grafana.app-v1.json +8 -0
- package/dist/apis/folder.grafana.app-v1beta1.json +8 -0
- package/dist/apis/iam.grafana.app-v0alpha1.json +58 -65
- package/dist/apis/preferences.grafana.app-v1alpha1.json +5 -23
- package/dist/apis/provisioning.grafana.app-v0alpha1.json +53 -26
- package/dist/apis/provisioning.grafana.app-v1beta1.json +43 -26
- package/package.json +1 -1
package/dist/api/openapi3.json
CHANGED
|
@@ -8125,9 +8125,6 @@
|
|
|
8125
8125
|
"queryHistory": {
|
|
8126
8126
|
"$ref": "#/components/schemas/QueryHistoryPreference"
|
|
8127
8127
|
},
|
|
8128
|
-
"regionalFormat": {
|
|
8129
|
-
"type": "string"
|
|
8130
|
-
},
|
|
8131
8128
|
"theme": {
|
|
8132
8129
|
"enum": ["light", "dark"],
|
|
8133
8130
|
"type": "string"
|
|
@@ -8764,6 +8761,10 @@
|
|
|
8764
8761
|
"description": "UID for the home dashboard",
|
|
8765
8762
|
"type": "string"
|
|
8766
8763
|
},
|
|
8764
|
+
"homeURL": {
|
|
8765
|
+
"description": "Explicit home URL (NOTE: this can only be modified in the system settings)",
|
|
8766
|
+
"type": "string"
|
|
8767
|
+
},
|
|
8767
8768
|
"language": {
|
|
8768
8769
|
"description": "Selected language",
|
|
8769
8770
|
"type": "string"
|
|
@@ -8774,10 +8775,6 @@
|
|
|
8774
8775
|
"queryHistory": {
|
|
8775
8776
|
"$ref": "#/components/schemas/PreferencesQueryHistoryPreference"
|
|
8776
8777
|
},
|
|
8777
|
-
"regionalFormat": {
|
|
8778
|
-
"description": "Selected locale (beta)\nTODO: Will be removed",
|
|
8779
|
-
"type": "string"
|
|
8780
|
-
},
|
|
8781
8778
|
"theme": {
|
|
8782
8779
|
"description": "user interface theme",
|
|
8783
8780
|
"type": "string"
|
|
@@ -11437,6 +11434,7 @@
|
|
|
11437
11434
|
"type": "string"
|
|
11438
11435
|
},
|
|
11439
11436
|
"uid": {
|
|
11437
|
+
"description": "Deprecated: always empty; no per-entry id.",
|
|
11440
11438
|
"type": "string"
|
|
11441
11439
|
}
|
|
11442
11440
|
},
|
|
@@ -12267,9 +12265,6 @@
|
|
|
12267
12265
|
"queryHistory": {
|
|
12268
12266
|
"$ref": "#/components/schemas/QueryHistoryPreference"
|
|
12269
12267
|
},
|
|
12270
|
-
"regionalFormat": {
|
|
12271
|
-
"type": "string"
|
|
12272
|
-
},
|
|
12273
12268
|
"theme": {
|
|
12274
12269
|
"enum": ["light", "dark", "system"],
|
|
12275
12270
|
"type": "string"
|
|
@@ -848,6 +848,14 @@
|
|
|
848
848
|
"type": "object",
|
|
849
849
|
"required": ["canSave", "canEdit", "canAdmin", "canDelete"],
|
|
850
850
|
"properties": {
|
|
851
|
+
"accessControl": {
|
|
852
|
+
"description": "AccessControl is a flat map of folder-domain action strings to bool, reflecting permissions after parent-chain inheritance has been resolved by the authorization system. Mirrors the shape of legacy dtos.Folder.AccessControl so clients can drop their dual call to /api/folders/{uid}?accesscontrol=true. Only keys for actions the user is granted appear here; absent keys mean \"not granted\".",
|
|
853
|
+
"type": "object",
|
|
854
|
+
"additionalProperties": {
|
|
855
|
+
"type": "boolean",
|
|
856
|
+
"default": false
|
|
857
|
+
}
|
|
858
|
+
},
|
|
851
859
|
"apiVersion": {
|
|
852
860
|
"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",
|
|
853
861
|
"type": "string"
|
|
@@ -848,6 +848,14 @@
|
|
|
848
848
|
"type": "object",
|
|
849
849
|
"required": ["canSave", "canEdit", "canAdmin", "canDelete"],
|
|
850
850
|
"properties": {
|
|
851
|
+
"accessControl": {
|
|
852
|
+
"description": "AccessControl is a flat map of folder-domain action strings to bool, reflecting permissions after parent-chain inheritance has been resolved by the authorization system. Mirrors the shape of legacy dtos.Folder.AccessControl so clients can drop their dual call to /api/folders/{uid}?accesscontrol=true. Only keys for actions the user is granted appear here; absent keys mean \"not granted\".",
|
|
853
|
+
"type": "object",
|
|
854
|
+
"additionalProperties": {
|
|
855
|
+
"type": "boolean",
|
|
856
|
+
"default": false
|
|
857
|
+
}
|
|
858
|
+
},
|
|
851
859
|
"apiVersion": {
|
|
852
860
|
"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",
|
|
853
861
|
"type": "string"
|
|
@@ -649,7 +649,7 @@
|
|
|
649
649
|
"/searchExternalGroupMappings": {
|
|
650
650
|
"post": {
|
|
651
651
|
"tags": ["Search"],
|
|
652
|
-
"description": "
|
|
652
|
+
"description": "Returns the team UIDs that map to any of the provided external group IDs.",
|
|
653
653
|
"operationId": "searchExternalGroupMappings",
|
|
654
654
|
"parameters": [
|
|
655
655
|
{
|
|
@@ -681,28 +681,6 @@
|
|
|
681
681
|
"format": "int64"
|
|
682
682
|
},
|
|
683
683
|
"example": 0
|
|
684
|
-
},
|
|
685
|
-
{
|
|
686
|
-
"name": "sort",
|
|
687
|
-
"in": "query",
|
|
688
|
-
"description": "sortable field",
|
|
689
|
-
"schema": {
|
|
690
|
-
"type": "string"
|
|
691
|
-
},
|
|
692
|
-
"examples": {
|
|
693
|
-
"": {
|
|
694
|
-
"summary": "default sorting",
|
|
695
|
-
"value": "externalGroup"
|
|
696
|
-
},
|
|
697
|
-
"-externalGroup": {
|
|
698
|
-
"summary": "externalGroup descending",
|
|
699
|
-
"value": "-externalGroup"
|
|
700
|
-
},
|
|
701
|
-
"externalGroup": {
|
|
702
|
-
"summary": "externalGroup ascending",
|
|
703
|
-
"value": "externalGroup"
|
|
704
|
-
}
|
|
705
|
-
}
|
|
706
684
|
}
|
|
707
685
|
],
|
|
708
686
|
"requestBody": {
|
|
@@ -3981,6 +3959,54 @@
|
|
|
3981
3959
|
},
|
|
3982
3960
|
"components": {
|
|
3983
3961
|
"schemas": {
|
|
3962
|
+
"CreateSearchExternalGroupMappingsBody": {
|
|
3963
|
+
"type": "object",
|
|
3964
|
+
"required": ["teams", "totalHits"],
|
|
3965
|
+
"properties": {
|
|
3966
|
+
"teams": {
|
|
3967
|
+
"description": "Deduplicated team UIDs whose spec.externalGroups intersect the request set.",
|
|
3968
|
+
"type": "array",
|
|
3969
|
+
"items": {
|
|
3970
|
+
"type": "string",
|
|
3971
|
+
"default": ""
|
|
3972
|
+
}
|
|
3973
|
+
},
|
|
3974
|
+
"totalHits": {
|
|
3975
|
+
"description": "Raw match count; may exceed len(teams) in legacy storage mode where one team can match through multiple group rows. Use to drive pagination, not as a team count.",
|
|
3976
|
+
"type": "integer",
|
|
3977
|
+
"format": "int64",
|
|
3978
|
+
"default": 0
|
|
3979
|
+
}
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"CreateSearchExternalGroupMappingsResponse": {
|
|
3983
|
+
"type": "object",
|
|
3984
|
+
"required": ["teams", "totalHits"],
|
|
3985
|
+
"properties": {
|
|
3986
|
+
"apiVersion": {
|
|
3987
|
+
"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",
|
|
3988
|
+
"type": "string"
|
|
3989
|
+
},
|
|
3990
|
+
"kind": {
|
|
3991
|
+
"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",
|
|
3992
|
+
"type": "string"
|
|
3993
|
+
},
|
|
3994
|
+
"teams": {
|
|
3995
|
+
"description": "Deduplicated team UIDs whose spec.externalGroups intersect the request set.",
|
|
3996
|
+
"type": "array",
|
|
3997
|
+
"items": {
|
|
3998
|
+
"type": "string",
|
|
3999
|
+
"default": ""
|
|
4000
|
+
}
|
|
4001
|
+
},
|
|
4002
|
+
"totalHits": {
|
|
4003
|
+
"description": "Raw match count; may exceed len(teams) in legacy storage mode where one team can match through multiple group rows. Use to drive pagination, not as a team count.",
|
|
4004
|
+
"type": "integer",
|
|
4005
|
+
"format": "int64",
|
|
4006
|
+
"default": 0
|
|
4007
|
+
}
|
|
4008
|
+
}
|
|
4009
|
+
},
|
|
3984
4010
|
"CreateServiceAccountTokenBody": {
|
|
3985
4011
|
"type": "object",
|
|
3986
4012
|
"required": ["token", "serviceAccountTokenName", "expires"],
|
|
@@ -4533,47 +4559,30 @@
|
|
|
4533
4559
|
},
|
|
4534
4560
|
"GetTeamGroupsBody": {
|
|
4535
4561
|
"type": "object",
|
|
4536
|
-
"required": ["
|
|
4562
|
+
"required": ["externalGroups"],
|
|
4537
4563
|
"properties": {
|
|
4538
|
-
"
|
|
4564
|
+
"externalGroups": {
|
|
4539
4565
|
"type": "array",
|
|
4540
4566
|
"items": {
|
|
4541
|
-
"
|
|
4567
|
+
"type": "string",
|
|
4568
|
+
"default": ""
|
|
4542
4569
|
}
|
|
4543
4570
|
}
|
|
4544
4571
|
}
|
|
4545
4572
|
},
|
|
4546
|
-
"GetTeamGroupsExternalGroupMapping": {
|
|
4547
|
-
"type": "object",
|
|
4548
|
-
"required": ["name", "externalGroup"],
|
|
4549
|
-
"properties": {
|
|
4550
|
-
"externalGroup": {
|
|
4551
|
-
"type": "string",
|
|
4552
|
-
"default": ""
|
|
4553
|
-
},
|
|
4554
|
-
"name": {
|
|
4555
|
-
"type": "string",
|
|
4556
|
-
"default": ""
|
|
4557
|
-
}
|
|
4558
|
-
}
|
|
4559
|
-
},
|
|
4560
4573
|
"GetTeamGroupsResponse": {
|
|
4561
4574
|
"type": "object",
|
|
4562
|
-
"required": ["
|
|
4575
|
+
"required": ["externalGroups"],
|
|
4563
4576
|
"properties": {
|
|
4564
4577
|
"apiVersion": {
|
|
4565
4578
|
"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",
|
|
4566
4579
|
"type": "string"
|
|
4567
4580
|
},
|
|
4568
|
-
"
|
|
4581
|
+
"externalGroups": {
|
|
4569
4582
|
"type": "array",
|
|
4570
4583
|
"items": {
|
|
4571
|
-
"
|
|
4572
|
-
"
|
|
4573
|
-
{
|
|
4574
|
-
"$ref": "#/components/schemas/GetTeamGroupsExternalGroupMapping"
|
|
4575
|
-
}
|
|
4576
|
-
]
|
|
4584
|
+
"type": "string",
|
|
4585
|
+
"default": ""
|
|
4577
4586
|
}
|
|
4578
4587
|
},
|
|
4579
4588
|
"kind": {
|
|
@@ -6180,22 +6189,6 @@
|
|
|
6180
6189
|
}
|
|
6181
6190
|
}
|
|
6182
6191
|
},
|
|
6183
|
-
"github.com/grafana/grafana/pkg/apis/iam/v0alpha1.IdentityRef": {
|
|
6184
|
-
"type": "object",
|
|
6185
|
-
"required": ["type", "name"],
|
|
6186
|
-
"properties": {
|
|
6187
|
-
"name": {
|
|
6188
|
-
"description": "Name is the unique identifier for identity, guaranteed to be a unique value for the type within a namespace.",
|
|
6189
|
-
"type": "string",
|
|
6190
|
-
"default": ""
|
|
6191
|
-
},
|
|
6192
|
-
"type": {
|
|
6193
|
-
"description": "Type of identity e.g. \"user\". For a full list see https://github.com/grafana/authlib/blob/d6737a7dc8f55e9d42834adb83b5da607ceed293/types/type.go#L15",
|
|
6194
|
-
"type": "string",
|
|
6195
|
-
"default": ""
|
|
6196
|
-
}
|
|
6197
|
-
}
|
|
6198
|
-
},
|
|
6199
6192
|
"github.com/grafana/grafana/pkg/apis/iam/v0alpha1.TeamMember": {
|
|
6200
6193
|
"type": "object",
|
|
6201
6194
|
"required": ["identity", "displayName"],
|
|
@@ -6217,7 +6210,7 @@
|
|
|
6217
6210
|
"default": {},
|
|
6218
6211
|
"allOf": [
|
|
6219
6212
|
{
|
|
6220
|
-
"$ref": "#/components/schemas/
|
|
6213
|
+
"$ref": "#/components/schemas/IdentityRef"
|
|
6221
6214
|
}
|
|
6222
6215
|
]
|
|
6223
6216
|
},
|
|
@@ -289,25 +289,7 @@
|
|
|
289
289
|
"content": {
|
|
290
290
|
"application/json": {
|
|
291
291
|
"schema": {
|
|
292
|
-
"
|
|
293
|
-
"required": ["metadata", "spec"],
|
|
294
|
-
"properties": {
|
|
295
|
-
"apiVersion": {
|
|
296
|
-
"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",
|
|
297
|
-
"type": "string"
|
|
298
|
-
},
|
|
299
|
-
"kind": {
|
|
300
|
-
"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",
|
|
301
|
-
"type": "string"
|
|
302
|
-
},
|
|
303
|
-
"metadata": {
|
|
304
|
-
"default": {}
|
|
305
|
-
},
|
|
306
|
-
"spec": {
|
|
307
|
-
"description": "Spec is the spec of the Preferences",
|
|
308
|
-
"default": {}
|
|
309
|
-
}
|
|
310
|
-
}
|
|
292
|
+
"$ref": "#/components/schemas/Preferences"
|
|
311
293
|
}
|
|
312
294
|
}
|
|
313
295
|
}
|
|
@@ -759,6 +741,10 @@
|
|
|
759
741
|
"description": "UID for the home dashboard",
|
|
760
742
|
"type": "string"
|
|
761
743
|
},
|
|
744
|
+
"homeURL": {
|
|
745
|
+
"description": "Explicit home URL (NOTE: this can only be modified in the system settings)",
|
|
746
|
+
"type": "string"
|
|
747
|
+
},
|
|
762
748
|
"language": {
|
|
763
749
|
"description": "Selected language",
|
|
764
750
|
"type": "string"
|
|
@@ -779,10 +765,6 @@
|
|
|
779
765
|
}
|
|
780
766
|
]
|
|
781
767
|
},
|
|
782
|
-
"regionalFormat": {
|
|
783
|
-
"description": "Selected locale (beta)",
|
|
784
|
-
"type": "string"
|
|
785
|
-
},
|
|
786
768
|
"theme": {
|
|
787
769
|
"description": "user interface theme",
|
|
788
770
|
"type": "string"
|
|
@@ -3715,29 +3715,6 @@
|
|
|
3715
3715
|
]
|
|
3716
3716
|
},
|
|
3717
3717
|
"/repositories/{name}/webhook": {
|
|
3718
|
-
"get": {
|
|
3719
|
-
"tags": ["Repository"],
|
|
3720
|
-
"description": "connect GET requests to webhook of Repository",
|
|
3721
|
-
"operationId": "getRepositoryWebhook",
|
|
3722
|
-
"responses": {
|
|
3723
|
-
"200": {
|
|
3724
|
-
"description": "OK",
|
|
3725
|
-
"content": {
|
|
3726
|
-
"*/*": {
|
|
3727
|
-
"schema": {
|
|
3728
|
-
"$ref": "#/components/schemas/WebhookResponse"
|
|
3729
|
-
}
|
|
3730
|
-
}
|
|
3731
|
-
}
|
|
3732
|
-
}
|
|
3733
|
-
},
|
|
3734
|
-
"x-kubernetes-action": "connect",
|
|
3735
|
-
"x-kubernetes-group-version-kind": {
|
|
3736
|
-
"group": "provisioning.grafana.app",
|
|
3737
|
-
"version": "v0alpha1",
|
|
3738
|
-
"kind": "WebhookResponse"
|
|
3739
|
-
}
|
|
3740
|
-
},
|
|
3741
3718
|
"post": {
|
|
3742
3719
|
"tags": ["Repository"],
|
|
3743
3720
|
"description": "Currently only supports github webhooks",
|
|
@@ -3866,11 +3843,28 @@
|
|
|
3866
3843
|
}
|
|
3867
3844
|
}
|
|
3868
3845
|
},
|
|
3846
|
+
"BranchOptions": {
|
|
3847
|
+
"type": "object",
|
|
3848
|
+
"properties": {
|
|
3849
|
+
"enforceTemplate": {
|
|
3850
|
+
"description": "When true, the branch name field in Save drawers is read-only.",
|
|
3851
|
+
"type": "boolean"
|
|
3852
|
+
},
|
|
3853
|
+
"nameTemplate": {
|
|
3854
|
+
"description": "Template for the branch name created in branch workflow. Supports variables: {{action}}, {{resourceKind}}, {{title}}, {{userLogin}}, {{random}}. {{random}} is a 6-character alphanumeric token generated at render time to avoid collisions. The result is sanitised to a valid git ref (lowercase, alphanumeric + dashes, max 100 chars). When empty, the current auto-generated name is preserved.",
|
|
3855
|
+
"type": "string"
|
|
3856
|
+
}
|
|
3857
|
+
}
|
|
3858
|
+
},
|
|
3869
3859
|
"CommitOptions": {
|
|
3870
3860
|
"type": "object",
|
|
3871
3861
|
"properties": {
|
|
3862
|
+
"enforceTemplate": {
|
|
3863
|
+
"description": "When true, the Comment field in Save drawers is pre-filled from SingleResourceMessageTemplate and rendered read-only. The Grafana-saved-by trailer is always appended regardless of this setting.",
|
|
3864
|
+
"type": "boolean"
|
|
3865
|
+
},
|
|
3872
3866
|
"singleResourceMessageTemplate": {
|
|
3873
|
-
"description": "Template for commit messages produced by single-resource UI operations (dashboard save/delete/move, folder create/rename/delete). Bulk operations and sync jobs are out of scope and build their own messages. Supports variables: {{action}}, {{resourceKind}}, {{resourceID}}, {{title}}. When empty, a built-in default is used (e.g. \"Save dashboard: <title>\").",
|
|
3867
|
+
"description": "Template for commit messages produced by single-resource UI operations (dashboard save/delete/move, folder create/rename/delete). Bulk operations and sync jobs are out of scope and build their own messages. Supports variables: {{action}}, {{resourceKind}}, {{resourceID}}, {{title}}, {{userName}}, {{userLogin}}, {{userEmail}}. When empty, a built-in default is used (e.g. \"Save dashboard: <title>\").",
|
|
3874
3868
|
"type": "string"
|
|
3875
3869
|
}
|
|
3876
3870
|
}
|
|
@@ -4187,7 +4181,7 @@
|
|
|
4187
4181
|
"type": "string"
|
|
4188
4182
|
},
|
|
4189
4183
|
"message": {
|
|
4190
|
-
"description": "Message to use when committing the changes in a single commit",
|
|
4184
|
+
"description": "Message to use when committing the changes in a single commit. Deprecated: set JobSpec.Message instead. This field is kept for backwards compatibility and is only used when JobSpec.Message is empty.",
|
|
4191
4185
|
"type": "string"
|
|
4192
4186
|
},
|
|
4193
4187
|
"path": {
|
|
@@ -4817,6 +4811,10 @@
|
|
|
4817
4811
|
}
|
|
4818
4812
|
]
|
|
4819
4813
|
},
|
|
4814
|
+
"message": {
|
|
4815
|
+
"description": "Commit message for this job. Applies to job actions that produce commits (delete, move, migrate, push, fixFolderMetadata). When empty, the backend falls back to the action-specific message field (ExportJobOptions.Message, MigrateJobOptions.Message) for backwards compatibility, then to a built-in default.",
|
|
4816
|
+
"type": "string"
|
|
4817
|
+
},
|
|
4820
4818
|
"migrate": {
|
|
4821
4819
|
"description": "Required when the action is `migrate`",
|
|
4822
4820
|
"allOf": [
|
|
@@ -4956,7 +4954,7 @@
|
|
|
4956
4954
|
"type": "object",
|
|
4957
4955
|
"properties": {
|
|
4958
4956
|
"message": {
|
|
4959
|
-
"description": "Message to use when committing the changes in a single commit",
|
|
4957
|
+
"description": "Message to use when committing the changes in a single commit. Deprecated: set JobSpec.Message instead. This field is kept for backwards compatibility and is only used when JobSpec.Message is empty.",
|
|
4960
4958
|
"type": "string"
|
|
4961
4959
|
},
|
|
4962
4960
|
"resources": {
|
|
@@ -5028,6 +5026,19 @@
|
|
|
5028
5026
|
}
|
|
5029
5027
|
}
|
|
5030
5028
|
},
|
|
5029
|
+
"PullRequestOptions": {
|
|
5030
|
+
"type": "object",
|
|
5031
|
+
"properties": {
|
|
5032
|
+
"enforceTemplate": {
|
|
5033
|
+
"description": "When true, the PR title field in Save drawers is read-only.",
|
|
5034
|
+
"type": "boolean"
|
|
5035
|
+
},
|
|
5036
|
+
"titleTemplate": {
|
|
5037
|
+
"description": "Template for pull request titles. Supports the same variables as BranchOptions.NameTemplate ({{random}} is available but rarely useful here). When empty, the first line of the commit message is used.",
|
|
5038
|
+
"type": "string"
|
|
5039
|
+
}
|
|
5040
|
+
}
|
|
5041
|
+
},
|
|
5031
5042
|
"QuotaStatus": {
|
|
5032
5043
|
"description": "QuotaStatus represents the quota limits configured for this repository. These values come from static configuration and are read-only.",
|
|
5033
5044
|
"type": "object",
|
|
@@ -5214,6 +5225,14 @@
|
|
|
5214
5225
|
}
|
|
5215
5226
|
]
|
|
5216
5227
|
},
|
|
5228
|
+
"branch": {
|
|
5229
|
+
"description": "Branch naming options. Only meaningful when Workflows includes \"branch\".",
|
|
5230
|
+
"allOf": [
|
|
5231
|
+
{
|
|
5232
|
+
"$ref": "#/components/schemas/BranchOptions"
|
|
5233
|
+
}
|
|
5234
|
+
]
|
|
5235
|
+
},
|
|
5217
5236
|
"commit": {
|
|
5218
5237
|
"description": "Commit message options. Currently only contains the template used by single-resource UI operations; future siblings (bulk, sync) can live here.",
|
|
5219
5238
|
"allOf": [
|
|
@@ -5274,6 +5293,14 @@
|
|
|
5274
5293
|
}
|
|
5275
5294
|
]
|
|
5276
5295
|
},
|
|
5296
|
+
"pullRequest": {
|
|
5297
|
+
"description": "Pull request options. Only meaningful when Workflows includes \"branch\".",
|
|
5298
|
+
"allOf": [
|
|
5299
|
+
{
|
|
5300
|
+
"$ref": "#/components/schemas/PullRequestOptions"
|
|
5301
|
+
}
|
|
5302
|
+
]
|
|
5303
|
+
},
|
|
5277
5304
|
"sync": {
|
|
5278
5305
|
"description": "Sync settings -- how values are pulled from the repository into grafana",
|
|
5279
5306
|
"default": {},
|
|
@@ -3715,29 +3715,6 @@
|
|
|
3715
3715
|
]
|
|
3716
3716
|
},
|
|
3717
3717
|
"/repositories/{name}/webhook": {
|
|
3718
|
-
"get": {
|
|
3719
|
-
"tags": ["Repository"],
|
|
3720
|
-
"description": "connect GET requests to webhook of Repository",
|
|
3721
|
-
"operationId": "getRepositoryWebhook",
|
|
3722
|
-
"responses": {
|
|
3723
|
-
"200": {
|
|
3724
|
-
"description": "OK",
|
|
3725
|
-
"content": {
|
|
3726
|
-
"*/*": {
|
|
3727
|
-
"schema": {
|
|
3728
|
-
"$ref": "#/components/schemas/WebhookResponse"
|
|
3729
|
-
}
|
|
3730
|
-
}
|
|
3731
|
-
}
|
|
3732
|
-
}
|
|
3733
|
-
},
|
|
3734
|
-
"x-kubernetes-action": "connect",
|
|
3735
|
-
"x-kubernetes-group-version-kind": {
|
|
3736
|
-
"group": "provisioning.grafana.app",
|
|
3737
|
-
"version": "v1beta1",
|
|
3738
|
-
"kind": "WebhookResponse"
|
|
3739
|
-
}
|
|
3740
|
-
},
|
|
3741
3718
|
"post": {
|
|
3742
3719
|
"tags": ["Repository"],
|
|
3743
3720
|
"description": "Currently only supports github webhooks",
|
|
@@ -3866,11 +3843,28 @@
|
|
|
3866
3843
|
}
|
|
3867
3844
|
}
|
|
3868
3845
|
},
|
|
3846
|
+
"BranchOptions": {
|
|
3847
|
+
"type": "object",
|
|
3848
|
+
"properties": {
|
|
3849
|
+
"enforceTemplate": {
|
|
3850
|
+
"description": "When true, the branch name field in Save drawers is read-only.",
|
|
3851
|
+
"type": "boolean"
|
|
3852
|
+
},
|
|
3853
|
+
"nameTemplate": {
|
|
3854
|
+
"description": "Template for the branch name created in branch workflow. Supports variables: {{action}}, {{resourceKind}}, {{title}}, {{userLogin}}, {{random}}. {{random}} is a 6-character alphanumeric token generated at render time to avoid collisions. The result is sanitised to a valid git ref (lowercase, alphanumeric + dashes, max 100 chars). When empty, the current auto-generated name is preserved.",
|
|
3855
|
+
"type": "string"
|
|
3856
|
+
}
|
|
3857
|
+
}
|
|
3858
|
+
},
|
|
3869
3859
|
"CommitOptions": {
|
|
3870
3860
|
"type": "object",
|
|
3871
3861
|
"properties": {
|
|
3862
|
+
"enforceTemplate": {
|
|
3863
|
+
"description": "When true, the Comment field in Save drawers is pre-filled from SingleResourceMessageTemplate and rendered read-only. The Grafana-saved-by trailer is always appended regardless of this setting.",
|
|
3864
|
+
"type": "boolean"
|
|
3865
|
+
},
|
|
3872
3866
|
"singleResourceMessageTemplate": {
|
|
3873
|
-
"description": "Template for commit messages produced by single-resource UI operations (dashboard save/delete/move, folder create/rename/delete). Bulk operations and sync jobs are out of scope and build their own messages. Supports variables: {{action}}, {{resourceKind}}, {{resourceID}}, {{title}}. When empty, a built-in default is used (e.g. \"Save dashboard: <title>\").",
|
|
3867
|
+
"description": "Template for commit messages produced by single-resource UI operations (dashboard save/delete/move, folder create/rename/delete). Bulk operations and sync jobs are out of scope and build their own messages. Supports variables: {{action}}, {{resourceKind}}, {{resourceID}}, {{title}}, {{userName}}, {{userLogin}}, {{userEmail}}. When empty, a built-in default is used (e.g. \"Save dashboard: <title>\").",
|
|
3874
3868
|
"type": "string"
|
|
3875
3869
|
}
|
|
3876
3870
|
}
|
|
@@ -4095,7 +4089,7 @@
|
|
|
4095
4089
|
"type": "string"
|
|
4096
4090
|
},
|
|
4097
4091
|
"message": {
|
|
4098
|
-
"description": "Message to use when committing the changes in a single commit",
|
|
4092
|
+
"description": "Message to use when committing the changes in a single commit. Deprecated: set JobSpec.Message instead. This field is kept for backwards compatibility and is only used when JobSpec.Message is empty.",
|
|
4099
4093
|
"type": "string"
|
|
4100
4094
|
},
|
|
4101
4095
|
"path": {
|
|
@@ -4629,6 +4623,10 @@
|
|
|
4629
4623
|
"fixFolderMetadata": {
|
|
4630
4624
|
"description": "Options when the action is `fix-folder-metadata`"
|
|
4631
4625
|
},
|
|
4626
|
+
"message": {
|
|
4627
|
+
"description": "Commit message for this job. Applies to job actions that produce commits (delete, move, migrate, push, fixFolderMetadata). When empty, the backend falls back to the action-specific message field (ExportJobOptions.Message, MigrateJobOptions.Message) for backwards compatibility, then to a built-in default.",
|
|
4628
|
+
"type": "string"
|
|
4629
|
+
},
|
|
4632
4630
|
"migrate": {
|
|
4633
4631
|
"description": "Required when the action is `migrate`"
|
|
4634
4632
|
},
|
|
@@ -4736,7 +4734,7 @@
|
|
|
4736
4734
|
"type": "object",
|
|
4737
4735
|
"properties": {
|
|
4738
4736
|
"message": {
|
|
4739
|
-
"description": "Message to use when committing the changes in a single commit",
|
|
4737
|
+
"description": "Message to use when committing the changes in a single commit. Deprecated: set JobSpec.Message instead. This field is kept for backwards compatibility and is only used when JobSpec.Message is empty.",
|
|
4740
4738
|
"type": "string"
|
|
4741
4739
|
},
|
|
4742
4740
|
"resources": {
|
|
@@ -4798,6 +4796,19 @@
|
|
|
4798
4796
|
}
|
|
4799
4797
|
}
|
|
4800
4798
|
},
|
|
4799
|
+
"PullRequestOptions": {
|
|
4800
|
+
"type": "object",
|
|
4801
|
+
"properties": {
|
|
4802
|
+
"enforceTemplate": {
|
|
4803
|
+
"description": "When true, the PR title field in Save drawers is read-only.",
|
|
4804
|
+
"type": "boolean"
|
|
4805
|
+
},
|
|
4806
|
+
"titleTemplate": {
|
|
4807
|
+
"description": "Template for pull request titles. Supports the same variables as BranchOptions.NameTemplate ({{random}} is available but rarely useful here). When empty, the first line of the commit message is used.",
|
|
4808
|
+
"type": "string"
|
|
4809
|
+
}
|
|
4810
|
+
}
|
|
4811
|
+
},
|
|
4801
4812
|
"QuotaStatus": {
|
|
4802
4813
|
"description": "QuotaStatus represents the quota limits configured for this repository. These values come from static configuration and are read-only.",
|
|
4803
4814
|
"type": "object",
|
|
@@ -4925,6 +4936,9 @@
|
|
|
4925
4936
|
"bitbucket": {
|
|
4926
4937
|
"description": "The repository on Bitbucket. Mutually exclusive with local | github | git."
|
|
4927
4938
|
},
|
|
4939
|
+
"branch": {
|
|
4940
|
+
"description": "Branch naming options. Only meaningful when Workflows includes \"branch\"."
|
|
4941
|
+
},
|
|
4928
4942
|
"commit": {
|
|
4929
4943
|
"description": "Commit message options. Currently only contains the template used by single-resource UI operations; future siblings (bulk, sync) can live here."
|
|
4930
4944
|
},
|
|
@@ -4950,6 +4964,9 @@
|
|
|
4950
4964
|
"local": {
|
|
4951
4965
|
"description": "The repository on the local file system. Mutually exclusive with local | github."
|
|
4952
4966
|
},
|
|
4967
|
+
"pullRequest": {
|
|
4968
|
+
"description": "Pull request options. Only meaningful when Workflows includes \"branch\"."
|
|
4969
|
+
},
|
|
4953
4970
|
"sync": {
|
|
4954
4971
|
"description": "Sync settings -- how values are pulled from the repository into grafana",
|
|
4955
4972
|
"default": {}
|