From ed736eb9a0da19c7d973fc25c90b18018ebad9a8 Mon Sep 17 00:00:00 2001 From: Ezequiel Victorero Date: Thu, 4 Jul 2024 12:01:23 -0300 Subject: [PATCH] Chore: Update swagger docs (#90065) --- public/api-enterprise-spec.json | 51 ++++++++++++++++++++++++++++++++- public/api-merged.json | 30 ++++++++++++++++++- public/openapi3.json | 30 ++++++++++++++++++- 3 files changed, 108 insertions(+), 3 deletions(-) diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index a2c5df56352..a33e984f9e1 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -1556,6 +1556,34 @@ } } }, + "/reports/images/:image": { + "get": { + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.settings:read`.", + "tags": [ + "reports", + "enterprise" + ], + "summary": "Get custom branding report image.", + "operationId": "getSettingsImage", + "responses": { + "200": { + "$ref": "#/responses/contentResponse" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "403": { + "$ref": "#/responses/forbiddenError" + }, + "404": { + "$ref": "#/responses/notFoundError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + } + }, "/reports/render/csvs": { "get": { "description": "Available to all users and with a valid license.", @@ -1666,7 +1694,7 @@ "reports", "enterprise" ], - "summary": "Get settings.", + "summary": "Get report settings.", "operationId": "getReportSettings", "responses": { "200": { @@ -5455,6 +5483,18 @@ } } }, + "NavbarPreference": { + "type": "object", + "title": "NavbarPreference defines model for NavbarPreference.", + "properties": { + "savedItemIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "NewApiKeyResult": { "type": "object", "properties": { @@ -5697,6 +5737,9 @@ "language": { "type": "string" }, + "navbar": { + "$ref": "#/definitions/NavbarPreference" + }, "queryHistory": { "$ref": "#/definitions/QueryHistoryPreference" }, @@ -5946,6 +5989,9 @@ "description": "Selected language (beta)", "type": "string" }, + "navbar": { + "$ref": "#/definitions/NavbarPreference" + }, "queryHistory": { "$ref": "#/definitions/QueryHistoryPreference" }, @@ -7935,6 +7981,9 @@ "language": { "type": "string" }, + "navbar": { + "$ref": "#/definitions/NavbarPreference" + }, "queryHistory": { "$ref": "#/definitions/QueryHistoryPreference" }, diff --git a/public/api-merged.json b/public/api-merged.json index 2fe5f57a88f..f30ece0f754 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -8051,6 +8051,34 @@ } } }, + "/reports/images/:image": { + "get": { + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.settings:read`.", + "tags": [ + "reports", + "enterprise" + ], + "summary": "Get custom branding report image.", + "operationId": "getSettingsImage", + "responses": { + "200": { + "$ref": "#/responses/contentResponse" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "403": { + "$ref": "#/responses/forbiddenError" + }, + "404": { + "$ref": "#/responses/notFoundError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + } + }, "/reports/render/csvs": { "get": { "description": "Available to all users and with a valid license.", @@ -8161,7 +8189,7 @@ "reports", "enterprise" ], - "summary": "Get settings.", + "summary": "Get report settings.", "operationId": "getReportSettings", "responses": { "200": { diff --git a/public/openapi3.json b/public/openapi3.json index 46d1e24a1c3..01b0937f681 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -21461,6 +21461,34 @@ ] } }, + "/reports/images/:image": { + "get": { + "description": "Available to org admins only and with a valid or expired license.\n\nYou need to have a permission with action `reports.settings:read`.", + "operationId": "getSettingsImage", + "responses": { + "200": { + "$ref": "#/components/responses/contentResponse" + }, + "401": { + "$ref": "#/components/responses/unauthorisedError" + }, + "403": { + "$ref": "#/components/responses/forbiddenError" + }, + "404": { + "$ref": "#/components/responses/notFoundError" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Get custom branding report image.", + "tags": [ + "reports", + "enterprise" + ] + } + }, "/reports/render/csvs": { "get": { "description": "Available to all users and with a valid license.", @@ -21592,7 +21620,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Get settings.", + "summary": "Get report settings.", "tags": [ "reports", "enterprise"