From 351425ab3d8eee7a579c19468549e4991e5455a7 Mon Sep 17 00:00:00 2001 From: Lucy Chen <140550297+lucychen-grafana@users.noreply.github.com> Date: Tue, 19 Mar 2024 17:19:14 -0400 Subject: [PATCH] Reporting: Update api doc files (#84358) --- public/api-enterprise-spec.json | 91 ---------------------------- public/api-merged.json | 91 ---------------------------- public/openapi3.json | 102 -------------------------------- 3 files changed, 284 deletions(-) diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index 301069e8f96..427770b9e9e 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -1330,74 +1330,6 @@ } } }, - "/reports/render/pdf/{dashboardID}": { - "get": { - "description": "Please refer to [reports enterprise](#/reports/renderReportPDFs) instead. This will be removed in Grafana 10.", - "produces": [ - "application/pdf" - ], - "tags": [ - "reports", - "enterprise" - ], - "summary": "Render report for dashboard.", - "operationId": "renderReportPDF", - "deprecated": true, - "parameters": [ - { - "type": "integer", - "format": "int64", - "name": "dashboardID", - "in": "path", - "required": true - }, - { - "type": "string", - "name": "title", - "in": "query" - }, - { - "type": "string", - "name": "variables", - "in": "query" - }, - { - "type": "string", - "name": "from", - "in": "query" - }, - { - "type": "string", - "name": "to", - "in": "query" - }, - { - "type": "string", - "name": "orientation", - "in": "query" - }, - { - "type": "string", - "name": "layout", - "in": "query" - } - ], - "responses": { - "200": { - "$ref": "#/responses/contentResponse" - }, - "400": { - "$ref": "#/responses/badRequestError" - }, - "401": { - "$ref": "#/responses/unauthorisedError" - }, - "500": { - "$ref": "#/responses/internalServerError" - } - } - } - }, "/reports/render/pdfs": { "get": { "description": "Available to all users and with a valid license.", @@ -3114,13 +3046,6 @@ "CreateOrUpdateReportConfig": { "type": "object", "properties": { - "dashboardId": { - "type": "integer", - "format": "int64" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "type": "array", "items": { @@ -3163,9 +3088,6 @@ }, "state": { "$ref": "#/definitions/State" - }, - "templateVars": { - "type": "object" } } }, @@ -5855,16 +5777,6 @@ "type": "string", "format": "date-time" }, - "dashboardId": { - "type": "integer", - "format": "int64" - }, - "dashboardName": { - "type": "string" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "type": "array", "items": { @@ -5916,9 +5828,6 @@ "state": { "$ref": "#/definitions/State" }, - "templateVars": { - "type": "object" - }, "uid": { "type": "string" }, diff --git a/public/api-merged.json b/public/api-merged.json index af87a514f74..03d6c51e6a0 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -7209,74 +7209,6 @@ } } }, - "/reports/render/pdf/{dashboardID}": { - "get": { - "description": "Please refer to [reports enterprise](#/reports/renderReportPDFs) instead. This will be removed in Grafana 10.", - "produces": [ - "application/pdf" - ], - "tags": [ - "reports", - "enterprise" - ], - "summary": "Render report for dashboard.", - "operationId": "renderReportPDF", - "deprecated": true, - "parameters": [ - { - "type": "integer", - "format": "int64", - "name": "dashboardID", - "in": "path", - "required": true - }, - { - "type": "string", - "name": "title", - "in": "query" - }, - { - "type": "string", - "name": "variables", - "in": "query" - }, - { - "type": "string", - "name": "from", - "in": "query" - }, - { - "type": "string", - "name": "to", - "in": "query" - }, - { - "type": "string", - "name": "orientation", - "in": "query" - }, - { - "type": "string", - "name": "layout", - "in": "query" - } - ], - "responses": { - "200": { - "$ref": "#/responses/contentResponse" - }, - "400": { - "$ref": "#/responses/badRequestError" - }, - "401": { - "$ref": "#/responses/unauthorisedError" - }, - "500": { - "$ref": "#/responses/internalServerError" - } - } - } - }, "/reports/render/pdfs": { "get": { "description": "Available to all users and with a valid license.", @@ -12846,13 +12778,6 @@ "CreateOrUpdateReportConfig": { "type": "object", "properties": { - "dashboardId": { - "type": "integer", - "format": "int64" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "type": "array", "items": { @@ -12895,9 +12820,6 @@ }, "state": { "$ref": "#/definitions/State" - }, - "templateVars": { - "type": "object" } } }, @@ -17690,16 +17612,6 @@ "type": "string", "format": "date-time" }, - "dashboardId": { - "type": "integer", - "format": "int64" - }, - "dashboardName": { - "type": "string" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "type": "array", "items": { @@ -17751,9 +17663,6 @@ "state": { "$ref": "#/definitions/State" }, - "templateVars": { - "type": "object" - }, "uid": { "type": "string" }, diff --git a/public/openapi3.json b/public/openapi3.json index ff2350ae0af..ed747c27fdd 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -3819,13 +3819,6 @@ }, "CreateOrUpdateReportConfig": { "properties": { - "dashboardId": { - "format": "int64", - "type": "integer" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "items": { "$ref": "#/components/schemas/ReportDashboard" @@ -3868,9 +3861,6 @@ }, "state": { "$ref": "#/components/schemas/State" - }, - "templateVars": { - "type": "object" } }, "type": "object" @@ -8663,16 +8653,6 @@ "format": "date-time", "type": "string" }, - "dashboardId": { - "format": "int64", - "type": "integer" - }, - "dashboardName": { - "type": "string" - }, - "dashboardUid": { - "type": "string" - }, "dashboards": { "items": { "$ref": "#/components/schemas/ReportDashboard" @@ -8724,9 +8704,6 @@ "state": { "$ref": "#/components/schemas/State" }, - "templateVars": { - "type": "object" - }, "uid": { "type": "string" }, @@ -19937,85 +19914,6 @@ ] } }, - "/reports/render/pdf/{dashboardID}": { - "get": { - "deprecated": true, - "description": "Please refer to [reports enterprise](#/reports/renderReportPDFs) instead. This will be removed in Grafana 10.", - "operationId": "renderReportPDF", - "parameters": [ - { - "in": "path", - "name": "dashboardID", - "required": true, - "schema": { - "format": "int64", - "type": "integer" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "variables", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "from", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "to", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orientation", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "layout", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/contentResponse" - }, - "400": { - "$ref": "#/components/responses/badRequestError" - }, - "401": { - "$ref": "#/components/responses/unauthorisedError" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "summary": "Render report for dashboard.", - "tags": [ - "reports", - "enterprise" - ] - } - }, "/reports/render/pdfs": { "get": { "description": "Available to all users and with a valid license.",