Skip to content

Commit b4c5c62

Browse files
Chore: Update api docs reporting (grafana#88878)
Co-authored-by: Agnès Toulet <[email protected]>
1 parent 3532d13 commit b4c5c62

File tree

3 files changed

+155
-3
lines changed

3 files changed

+155
-3
lines changed

public/api-enterprise-spec.json

+50-1
Original file line numberDiff line numberDiff line change
@@ -1556,6 +1556,49 @@
15561556
}
15571557
}
15581558
},
1559+
"/reports/render/csvs": {
1560+
"get": {
1561+
"description": "Available to all users and with a valid license.",
1562+
"produces": [
1563+
"application/zip"
1564+
],
1565+
"tags": [
1566+
"reports",
1567+
"enterprise"
1568+
],
1569+
"summary": "Download a CSV report.",
1570+
"operationId": "renderReportCSVs",
1571+
"parameters": [
1572+
{
1573+
"type": "string",
1574+
"name": "dashboards",
1575+
"in": "query"
1576+
},
1577+
{
1578+
"type": "string",
1579+
"name": "title",
1580+
"in": "query"
1581+
}
1582+
],
1583+
"responses": {
1584+
"200": {
1585+
"$ref": "#/responses/contentResponse"
1586+
},
1587+
"204": {
1588+
"$ref": "#/responses/noContentResponse"
1589+
},
1590+
"400": {
1591+
"$ref": "#/responses/badRequestError"
1592+
},
1593+
"401": {
1594+
"$ref": "#/responses/unauthorisedError"
1595+
},
1596+
"500": {
1597+
"$ref": "#/responses/internalServerError"
1598+
}
1599+
}
1600+
}
1601+
},
15591602
"/reports/render/pdfs": {
15601603
"get": {
15611604
"description": "Available to all users and with a valid license.",
@@ -1571,7 +1614,7 @@
15711614
"parameters": [
15721615
{
15731616
"type": "string",
1574-
"name": "dashboardID",
1617+
"name": "dashboards",
15751618
"in": "query"
15761619
},
15771620
{
@@ -9303,6 +9346,12 @@
93039346
}
93049347
}
93059348
},
9349+
"noContentResponse": {
9350+
"description": "",
9351+
"schema": {
9352+
"type": "object"
9353+
}
9354+
},
93069355
"notFoundError": {
93079356
"description": "NotFoundError is returned when the requested resource was not found.",
93089357
"schema": {

public/api-merged.json

+50-1
Original file line numberDiff line numberDiff line change
@@ -7800,6 +7800,49 @@
78007800
}
78017801
}
78027802
},
7803+
"/reports/render/csvs": {
7804+
"get": {
7805+
"description": "Available to all users and with a valid license.",
7806+
"produces": [
7807+
"application/zip"
7808+
],
7809+
"tags": [
7810+
"reports",
7811+
"enterprise"
7812+
],
7813+
"summary": "Download a CSV report.",
7814+
"operationId": "renderReportCSVs",
7815+
"parameters": [
7816+
{
7817+
"type": "string",
7818+
"name": "dashboards",
7819+
"in": "query"
7820+
},
7821+
{
7822+
"type": "string",
7823+
"name": "title",
7824+
"in": "query"
7825+
}
7826+
],
7827+
"responses": {
7828+
"200": {
7829+
"$ref": "#/responses/contentResponse"
7830+
},
7831+
"204": {
7832+
"$ref": "#/responses/noContentResponse"
7833+
},
7834+
"400": {
7835+
"$ref": "#/responses/badRequestError"
7836+
},
7837+
"401": {
7838+
"$ref": "#/responses/unauthorisedError"
7839+
},
7840+
"500": {
7841+
"$ref": "#/responses/internalServerError"
7842+
}
7843+
}
7844+
}
7845+
},
78037846
"/reports/render/pdfs": {
78047847
"get": {
78057848
"description": "Available to all users and with a valid license.",
@@ -7815,7 +7858,7 @@
78157858
"parameters": [
78167859
{
78177860
"type": "string",
7818-
"name": "dashboardID",
7861+
"name": "dashboards",
78197862
"in": "query"
78207863
},
78217864
{
@@ -23343,6 +23386,12 @@
2334323386
}
2334423387
}
2334523388
},
23389+
"noContentResponse": {
23390+
"description": "(empty)",
23391+
"schema": {
23392+
"type": "object"
23393+
}
23394+
},
2334623395
"notFoundError": {
2334723396
"description": "NotFoundError is returned when the requested resource was not found.",
2334823397
"schema": {

public/openapi3.json

+55-1
Original file line numberDiff line numberDiff line change
@@ -1555,6 +1555,16 @@
15551555
},
15561556
"description": "(empty)"
15571557
},
1558+
"noContentResponse": {
1559+
"content": {
1560+
"application/json": {
1561+
"schema": {
1562+
"type": "object"
1563+
}
1564+
}
1565+
},
1566+
"description": "(empty)"
1567+
},
15581568
"notFoundError": {
15591569
"content": {
15601570
"application/json": {
@@ -21031,14 +21041,58 @@
2103121041
]
2103221042
}
2103321043
},
21044+
"/reports/render/csvs": {
21045+
"get": {
21046+
"description": "Available to all users and with a valid license.",
21047+
"operationId": "renderReportCSVs",
21048+
"parameters": [
21049+
{
21050+
"in": "query",
21051+
"name": "dashboards",
21052+
"schema": {
21053+
"type": "string"
21054+
}
21055+
},
21056+
{
21057+
"in": "query",
21058+
"name": "title",
21059+
"schema": {
21060+
"type": "string"
21061+
}
21062+
}
21063+
],
21064+
"responses": {
21065+
"200": {
21066+
"$ref": "#/components/responses/contentResponse"
21067+
},
21068+
"204": {
21069+
"$ref": "#/components/responses/noContentResponse"
21070+
},
21071+
"400": {
21072+
"$ref": "#/components/responses/badRequestError"
21073+
},
21074+
"401": {
21075+
"$ref": "#/components/responses/unauthorisedError"
21076+
},
21077+
"500": {
21078+
"$ref": "#/components/responses/internalServerError"
21079+
}
21080+
},
21081+
"summary": "Download a CSV report.",
21082+
"tags": [
21083+
"reports",
21084+
"enterprise"
21085+
]
21086+
}
21087+
},
2103421088
"/reports/render/pdfs": {
2103521089
"get": {
2103621090
"description": "Available to all users and with a valid license.",
2103721091
"operationId": "renderReportPDFs",
2103821092
"parameters": [
2103921093
{
2104021094
"in": "query",
21041-
"name": "dashboardID",
21095+
"name": "dashboards",
2104221096
"schema": {
2104321097
"type": "string"
2104421098
}

0 commit comments

Comments
 (0)