Reporting: Update api doc files (#84358)

This commit is contained in:
Lucy Chen 2024-03-19 17:19:14 -04:00 committed by GitHub
parent 1cc31a4d62
commit 351425ab3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 0 additions and 284 deletions

View File

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

View File

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

View File

@ -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.",