mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Chore: Update api docs reporting (#88878)
Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
This commit is contained in:
parent
3532d13f0c
commit
b4c5c62f59
@ -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": {
|
"/reports/render/pdfs": {
|
||||||
"get": {
|
"get": {
|
||||||
"description": "Available to all users and with a valid license.",
|
"description": "Available to all users and with a valid license.",
|
||||||
@ -1571,7 +1614,7 @@
|
|||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"name": "dashboardID",
|
"name": "dashboards",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -9303,6 +9346,12 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"noContentResponse": {
|
||||||
|
"description": "",
|
||||||
|
"schema": {
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
},
|
||||||
"notFoundError": {
|
"notFoundError": {
|
||||||
"description": "NotFoundError is returned when the requested resource was not found.",
|
"description": "NotFoundError is returned when the requested resource was not found.",
|
||||||
"schema": {
|
"schema": {
|
||||||
|
@ -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": {
|
"/reports/render/pdfs": {
|
||||||
"get": {
|
"get": {
|
||||||
"description": "Available to all users and with a valid license.",
|
"description": "Available to all users and with a valid license.",
|
||||||
@ -7815,7 +7858,7 @@
|
|||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"name": "dashboardID",
|
"name": "dashboards",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -23343,6 +23386,12 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"noContentResponse": {
|
||||||
|
"description": "(empty)",
|
||||||
|
"schema": {
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
},
|
||||||
"notFoundError": {
|
"notFoundError": {
|
||||||
"description": "NotFoundError is returned when the requested resource was not found.",
|
"description": "NotFoundError is returned when the requested resource was not found.",
|
||||||
"schema": {
|
"schema": {
|
||||||
|
@ -1555,6 +1555,16 @@
|
|||||||
},
|
},
|
||||||
"description": "(empty)"
|
"description": "(empty)"
|
||||||
},
|
},
|
||||||
|
"noContentResponse": {
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description": "(empty)"
|
||||||
|
},
|
||||||
"notFoundError": {
|
"notFoundError": {
|
||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"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": {
|
"/reports/render/pdfs": {
|
||||||
"get": {
|
"get": {
|
||||||
"description": "Available to all users and with a valid license.",
|
"description": "Available to all users and with a valid license.",
|
||||||
@ -21038,7 +21092,7 @@
|
|||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"name": "dashboardID",
|
"name": "dashboards",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user