@grafana/openapi 13.0.0-23610169033 → 13.0.0-23612276680
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 +28 -44
- package/package.json +1 -1
package/dist/api/openapi3.json
CHANGED
|
@@ -17016,7 +17016,8 @@
|
|
|
17016
17016
|
},
|
|
17017
17017
|
"/dashboards/db": {
|
|
17018
17018
|
"post": {
|
|
17019
|
-
"
|
|
17019
|
+
"deprecated": true,
|
|
17020
|
+
"description": "Creates a new dashboard or updates an existing dashboard.\nNote: This endpoint is not intended for creating folders, use `POST /api/folders` for that.\n\nUse: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards",
|
|
17020
17021
|
"operationId": "postDashboard",
|
|
17021
17022
|
"requestBody": {
|
|
17022
17023
|
"content": {
|
|
@@ -17163,6 +17164,7 @@
|
|
|
17163
17164
|
},
|
|
17164
17165
|
"/dashboards/tags": {
|
|
17165
17166
|
"get": {
|
|
17167
|
+
"deprecated": true,
|
|
17166
17168
|
"operationId": "getDashboardTags",
|
|
17167
17169
|
"responses": {
|
|
17168
17170
|
"200": {
|
|
@@ -17175,7 +17177,7 @@
|
|
|
17175
17177
|
"$ref": "#/components/responses/internalServerError"
|
|
17176
17178
|
}
|
|
17177
17179
|
},
|
|
17178
|
-
"summary": "Get all dashboards tags of an
|
|
17180
|
+
"summary": "Get all dashboards tags of an organization.",
|
|
17179
17181
|
"tags": ["dashboards"]
|
|
17180
17182
|
}
|
|
17181
17183
|
},
|
|
@@ -17354,7 +17356,8 @@
|
|
|
17354
17356
|
},
|
|
17355
17357
|
"/dashboards/uid/{uid}": {
|
|
17356
17358
|
"delete": {
|
|
17357
|
-
"
|
|
17359
|
+
"deprecated": true,
|
|
17360
|
+
"description": "Will delete the dashboard given the specified unique identifier (uid).\n\nUse: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}",
|
|
17358
17361
|
"operationId": "deleteDashboardByUID",
|
|
17359
17362
|
"parameters": [
|
|
17360
17363
|
{
|
|
@@ -17387,7 +17390,8 @@
|
|
|
17387
17390
|
"tags": ["dashboards"]
|
|
17388
17391
|
},
|
|
17389
17392
|
"get": {
|
|
17390
|
-
"
|
|
17393
|
+
"deprecated": true,
|
|
17394
|
+
"description": "Optional query parameter `apiVersion` selects the Kubernetes API version used to load the dashboard first\n(for example `v1beta1`). If that request fails, the default version is used instead. When omitted, only the default is used.\n\nWill return the dashboard given the dashboard unique identifier (uid).\n\nUse: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}",
|
|
17391
17395
|
"operationId": "getDashboardByUID",
|
|
17392
17396
|
"parameters": [
|
|
17393
17397
|
{
|
|
@@ -17425,6 +17429,8 @@
|
|
|
17425
17429
|
},
|
|
17426
17430
|
"/dashboards/uid/{uid}/permissions": {
|
|
17427
17431
|
"get": {
|
|
17432
|
+
"deprecated": true,
|
|
17433
|
+
"description": "Use: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}/access",
|
|
17428
17434
|
"operationId": "getDashboardPermissionsListByUID",
|
|
17429
17435
|
"parameters": [
|
|
17430
17436
|
{
|
|
@@ -17457,6 +17463,7 @@
|
|
|
17457
17463
|
"tags": ["dashboards", "permissions"]
|
|
17458
17464
|
},
|
|
17459
17465
|
"post": {
|
|
17466
|
+
"deprecated": true,
|
|
17460
17467
|
"description": "This operation will remove existing permissions if they’re not included in the request.",
|
|
17461
17468
|
"operationId": "updateDashboardPermissionsByUID",
|
|
17462
17469
|
"parameters": [
|
|
@@ -17556,6 +17563,7 @@
|
|
|
17556
17563
|
},
|
|
17557
17564
|
"/dashboards/uid/{uid}/versions": {
|
|
17558
17565
|
"get": {
|
|
17566
|
+
"deprecated": true,
|
|
17559
17567
|
"operationId": "getDashboardVersionsByUID",
|
|
17560
17568
|
"parameters": [
|
|
17561
17569
|
{
|
|
@@ -17610,6 +17618,7 @@
|
|
|
17610
17618
|
},
|
|
17611
17619
|
"/dashboards/uid/{uid}/versions/{DashboardVersionID}": {
|
|
17612
17620
|
"get": {
|
|
17621
|
+
"deprecated": true,
|
|
17613
17622
|
"operationId": "getDashboardVersionByUID",
|
|
17614
17623
|
"parameters": [
|
|
17615
17624
|
{
|
|
@@ -18739,7 +18748,8 @@
|
|
|
18739
18748
|
},
|
|
18740
18749
|
"/folders": {
|
|
18741
18750
|
"get": {
|
|
18742
|
-
"
|
|
18751
|
+
"deprecated": true,
|
|
18752
|
+
"description": "It returns all folders that the authenticated user has permission to view.\nIf nested folders are enabled, it expects an additional query parameter with the parent folder UID\nand returns the immediate subfolders that the authenticated user has permission to view.\nIf the parameter is not supplied then it returns immediate subfolders under the root\nthat the authenticated user has permission to view.\n\nUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders",
|
|
18743
18753
|
"operationId": "getFolders",
|
|
18744
18754
|
"parameters": [
|
|
18745
18755
|
{
|
|
@@ -18799,7 +18809,8 @@
|
|
|
18799
18809
|
"tags": ["folders"]
|
|
18800
18810
|
},
|
|
18801
18811
|
"post": {
|
|
18802
|
-
"
|
|
18812
|
+
"deprecated": true,
|
|
18813
|
+
"description": "If nested folders are enabled then it additionally expects the parent folder UID.\n\nUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}",
|
|
18803
18814
|
"operationId": "createFolder",
|
|
18804
18815
|
"requestBody": {
|
|
18805
18816
|
"content": {
|
|
@@ -18836,46 +18847,10 @@
|
|
|
18836
18847
|
"tags": ["folders"]
|
|
18837
18848
|
}
|
|
18838
18849
|
},
|
|
18839
|
-
"/folders/id/{folder_id}": {
|
|
18840
|
-
"get": {
|
|
18841
|
-
"deprecated": true,
|
|
18842
|
-
"description": "Returns the folder identified by id. This is deprecated.\nPlease refer to [updated API](#/folders/getFolderByUID) instead",
|
|
18843
|
-
"operationId": "getFolderByID",
|
|
18844
|
-
"parameters": [
|
|
18845
|
-
{
|
|
18846
|
-
"in": "path",
|
|
18847
|
-
"name": "folder_id",
|
|
18848
|
-
"required": true,
|
|
18849
|
-
"schema": {
|
|
18850
|
-
"format": "int64",
|
|
18851
|
-
"type": "integer"
|
|
18852
|
-
}
|
|
18853
|
-
}
|
|
18854
|
-
],
|
|
18855
|
-
"responses": {
|
|
18856
|
-
"200": {
|
|
18857
|
-
"$ref": "#/components/responses/folderResponse"
|
|
18858
|
-
},
|
|
18859
|
-
"401": {
|
|
18860
|
-
"$ref": "#/components/responses/unauthorisedError"
|
|
18861
|
-
},
|
|
18862
|
-
"403": {
|
|
18863
|
-
"$ref": "#/components/responses/forbiddenError"
|
|
18864
|
-
},
|
|
18865
|
-
"404": {
|
|
18866
|
-
"$ref": "#/components/responses/notFoundError"
|
|
18867
|
-
},
|
|
18868
|
-
"500": {
|
|
18869
|
-
"$ref": "#/components/responses/internalServerError"
|
|
18870
|
-
}
|
|
18871
|
-
},
|
|
18872
|
-
"summary": "Get folder by id.",
|
|
18873
|
-
"tags": ["folders"]
|
|
18874
|
-
}
|
|
18875
|
-
},
|
|
18876
18850
|
"/folders/{folder_uid}": {
|
|
18877
18851
|
"delete": {
|
|
18878
|
-
"
|
|
18852
|
+
"deprecated": true,
|
|
18853
|
+
"description": "Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted.\nIf nested folders are enabled then it also deletes all the subfolders.\n\nUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}",
|
|
18879
18854
|
"operationId": "deleteFolder",
|
|
18880
18855
|
"parameters": [
|
|
18881
18856
|
{
|
|
@@ -18920,6 +18895,8 @@
|
|
|
18920
18895
|
"tags": ["folders"]
|
|
18921
18896
|
},
|
|
18922
18897
|
"get": {
|
|
18898
|
+
"deprecated": true,
|
|
18899
|
+
"description": "Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}",
|
|
18923
18900
|
"operationId": "getFolderByUID",
|
|
18924
18901
|
"parameters": [
|
|
18925
18902
|
{
|
|
@@ -18952,6 +18929,8 @@
|
|
|
18952
18929
|
"tags": ["folders"]
|
|
18953
18930
|
},
|
|
18954
18931
|
"put": {
|
|
18932
|
+
"deprecated": true,
|
|
18933
|
+
"description": "Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}",
|
|
18955
18934
|
"operationId": "updateFolder",
|
|
18956
18935
|
"parameters": [
|
|
18957
18936
|
{
|
|
@@ -19004,6 +18983,8 @@
|
|
|
19004
18983
|
},
|
|
19005
18984
|
"/folders/{folder_uid}/counts": {
|
|
19006
18985
|
"get": {
|
|
18986
|
+
"deprecated": true,
|
|
18987
|
+
"description": "Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}",
|
|
19007
18988
|
"operationId": "getFolderDescendantCounts",
|
|
19008
18989
|
"parameters": [
|
|
19009
18990
|
{
|
|
@@ -19038,6 +19019,8 @@
|
|
|
19038
19019
|
},
|
|
19039
19020
|
"/folders/{folder_uid}/move": {
|
|
19040
19021
|
"post": {
|
|
19022
|
+
"deprecated": true,
|
|
19023
|
+
"description": "Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid},\nChanging the parent folder annotation",
|
|
19041
19024
|
"operationId": "moveFolder",
|
|
19042
19025
|
"parameters": [
|
|
19043
19026
|
{
|
|
@@ -19083,6 +19066,7 @@
|
|
|
19083
19066
|
},
|
|
19084
19067
|
"/folders/{folder_uid}/permissions": {
|
|
19085
19068
|
"get": {
|
|
19069
|
+
"deprecated": true,
|
|
19086
19070
|
"operationId": "getFolderPermissionList",
|
|
19087
19071
|
"parameters": [
|
|
19088
19072
|
{
|