From 6c9afba607fd5939b9922eec490a3118f1af902b Mon Sep 17 00:00:00 2001 From: Ryan McKinley Date: Thu, 7 Nov 2024 15:08:03 +0300 Subject: [PATCH] Reporting: update swagger with deprecations (#96008) --- public/api-enterprise-spec.json | 9 ++++++--- public/api-merged.json | 9 ++++++--- public/openapi3.json | 9 ++++++--- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index 6a4a0c77f26..a904265749b 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -2119,13 +2119,14 @@ }, "/reports/{id}": { "get": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Get a report.", "operationId": "getReport", + "deprecated": true, "parameters": [ { "type": "integer", @@ -2157,13 +2158,14 @@ } }, "put": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Update a report.", "operationId": "updateReport", + "deprecated": true, "parameters": [ { "name": "body", @@ -2203,13 +2205,14 @@ } }, "delete": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Delete a report.", "operationId": "deleteReport", + "deprecated": true, "parameters": [ { "type": "integer", diff --git a/public/api-merged.json b/public/api-merged.json index 079f4a7987b..3d387d18331 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -8511,13 +8511,14 @@ }, "/reports/{id}": { "get": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Get a report.", "operationId": "getReport", + "deprecated": true, "parameters": [ { "type": "integer", @@ -8549,13 +8550,14 @@ } }, "put": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Update a report.", "operationId": "updateReport", + "deprecated": true, "parameters": [ { "name": "body", @@ -8595,13 +8597,14 @@ } }, "delete": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.", + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "tags": [ "reports", "enterprise" ], "summary": "Delete a report.", "operationId": "deleteReport", + "deprecated": true, "parameters": [ { "type": "integer", diff --git a/public/openapi3.json b/public/openapi3.json index 0be04ad9683..0d59d31e9a0 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -22432,7 +22432,8 @@ }, "/reports/{id}": { "delete": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.", + "deprecated": true, + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.delete` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "operationId": "deleteReport", "parameters": [ { @@ -22472,7 +22473,8 @@ ] }, "get": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.", + "deprecated": true, + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports:read` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "operationId": "getReport", "parameters": [ { @@ -22512,7 +22514,8 @@ ] }, "put": { - "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.", + "deprecated": true, + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.admin:write` with scope `reports:id:\u003creport ID\u003e`.\n\nRequesting reports using the internal id will stop workgin in the future\nUse the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/", "operationId": "updateReport", "parameters": [ {