IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-28 18:01:40 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Update api docs reporting (#88878)

Browse Source 
Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
This commit is contained in:
Ezequiel Victorero 2024-06-18 08:16:58 -03:00 committed by GitHub
parent 3532d13f0c
commit b4c5c62f59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 155 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
public/api-enterprise-spec.json
View File

@ -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": {

51
public/api-merged.json
View File

@ -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": {

56
public/openapi3.json
View File

@ -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"
}