From b4c5c62f59f6c60d9ec802516e44792dfe0a273e Mon Sep 17 00:00:00 2001 From: Ezequiel Victorero Date: Tue, 18 Jun 2024 08:16:58 -0300 Subject: [PATCH] Chore: Update api docs reporting (#88878) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com> --- public/api-enterprise-spec.json | 51 +++++++++++++++++++++++++++++- public/api-merged.json | 51 +++++++++++++++++++++++++++++- public/openapi3.json | 56 ++++++++++++++++++++++++++++++++- 3 files changed, 155 insertions(+), 3 deletions(-) diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index 4be1d3a41a6..d8f4afb84c7 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -1556,6 +1556,49 @@ } } }, + "/reports/render/csvs": { + "get": { + "description": "Available to all users and with a valid license.", + "produces": [ + "application/zip" + ], + "tags": [ + "reports", + "enterprise" + ], + "summary": "Download a CSV report.", + "operationId": "renderReportCSVs", + "parameters": [ + { + "type": "string", + "name": "dashboards", + "in": "query" + }, + { + "type": "string", + "name": "title", + "in": "query" + } + ], + "responses": { + "200": { + "$ref": "#/responses/contentResponse" + }, + "204": { + "$ref": "#/responses/noContentResponse" + }, + "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.", @@ -1571,7 +1614,7 @@ "parameters": [ { "type": "string", - "name": "dashboardID", + "name": "dashboards", "in": "query" }, { @@ -9303,6 +9346,12 @@ } } }, + "noContentResponse": { + "description": "", + "schema": { + "type": "object" + } + }, "notFoundError": { "description": "NotFoundError is returned when the requested resource was not found.", "schema": { diff --git a/public/api-merged.json b/public/api-merged.json index 26cf2ef2017..911dcfe26f1 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -7800,6 +7800,49 @@ } } }, + "/reports/render/csvs": { + "get": { + "description": "Available to all users and with a valid license.", + "produces": [ + "application/zip" + ], + "tags": [ + "reports", + "enterprise" + ], + "summary": "Download a CSV report.", + "operationId": "renderReportCSVs", + "parameters": [ + { + "type": "string", + "name": "dashboards", + "in": "query" + }, + { + "type": "string", + "name": "title", + "in": "query" + } + ], + "responses": { + "200": { + "$ref": "#/responses/contentResponse" + }, + "204": { + "$ref": "#/responses/noContentResponse" + }, + "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.", @@ -7815,7 +7858,7 @@ "parameters": [ { "type": "string", - "name": "dashboardID", + "name": "dashboards", "in": "query" }, { @@ -23343,6 +23386,12 @@ } } }, + "noContentResponse": { + "description": "(empty)", + "schema": { + "type": "object" + } + }, "notFoundError": { "description": "NotFoundError is returned when the requested resource was not found.", "schema": { diff --git a/public/openapi3.json b/public/openapi3.json index a00082e3deb..c7013037599 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -1555,6 +1555,16 @@ }, "description": "(empty)" }, + "noContentResponse": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + }, + "description": "(empty)" + }, "notFoundError": { "content": { "application/json": { @@ -21031,6 +21041,50 @@ ] } }, + "/reports/render/csvs": { + "get": { + "description": "Available to all users and with a valid license.", + "operationId": "renderReportCSVs", + "parameters": [ + { + "in": "query", + "name": "dashboards", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "title", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/contentResponse" + }, + "204": { + "$ref": "#/components/responses/noContentResponse" + }, + "400": { + "$ref": "#/components/responses/badRequestError" + }, + "401": { + "$ref": "#/components/responses/unauthorisedError" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Download a CSV report.", + "tags": [ + "reports", + "enterprise" + ] + } + }, "/reports/render/pdfs": { "get": { "description": "Available to all users and with a valid license.", @@ -21038,7 +21092,7 @@ "parameters": [ { "in": "query", - "name": "dashboardID", + "name": "dashboards", "schema": { "type": "string" }