Reporting: update swagger with deprecations (#96008)

This commit is contained in:
Ryan McKinley 2024-11-07 15:08:03 +03:00 committed by GitHub
parent b87c76ad21
commit 6c9afba607
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 18 additions and 9 deletions

View File

@ -2119,13 +2119,14 @@
}, },
"/reports/{id}": { "/reports/{id}": {
"get": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Get a report.", "summary": "Get a report.",
"operationId": "getReport", "operationId": "getReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
@ -2157,13 +2158,14 @@
} }
}, },
"put": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Update a report.", "summary": "Update a report.",
"operationId": "updateReport", "operationId": "updateReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"name": "body", "name": "body",
@ -2203,13 +2205,14 @@
} }
}, },
"delete": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Delete a report.", "summary": "Delete a report.",
"operationId": "deleteReport", "operationId": "deleteReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",

View File

@ -8511,13 +8511,14 @@
}, },
"/reports/{id}": { "/reports/{id}": {
"get": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Get a report.", "summary": "Get a report.",
"operationId": "getReport", "operationId": "getReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
@ -8549,13 +8550,14 @@
} }
}, },
"put": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Update a report.", "summary": "Update a report.",
"operationId": "updateReport", "operationId": "updateReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"name": "body", "name": "body",
@ -8595,13 +8597,14 @@
} }
}, },
"delete": { "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": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Delete a report.", "summary": "Delete a report.",
"operationId": "deleteReport", "operationId": "deleteReport",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",

View File

@ -22432,7 +22432,8 @@
}, },
"/reports/{id}": { "/reports/{id}": {
"delete": { "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", "operationId": "deleteReport",
"parameters": [ "parameters": [
{ {
@ -22472,7 +22473,8 @@
] ]
}, },
"get": { "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", "operationId": "getReport",
"parameters": [ "parameters": [
{ {
@ -22512,7 +22514,8 @@
] ]
}, },
"put": { "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", "operationId": "updateReport",
"parameters": [ "parameters": [
{ {