Chore: Update swagger docs (#90065)

This commit is contained in:
Ezequiel Victorero 2024-07-04 12:01:23 -03:00 committed by GitHub
parent 6daadd6b78
commit ed736eb9a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 108 additions and 3 deletions

View File

@ -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": { "/reports/render/csvs": {
"get": { "get": {
"description": "Available to all users and with a valid license.", "description": "Available to all users and with a valid license.",
@ -1666,7 +1694,7 @@
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Get settings.", "summary": "Get report settings.",
"operationId": "getReportSettings", "operationId": "getReportSettings",
"responses": { "responses": {
"200": { "200": {
@ -5455,6 +5483,18 @@
} }
} }
}, },
"NavbarPreference": {
"type": "object",
"title": "NavbarPreference defines model for NavbarPreference.",
"properties": {
"savedItemIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"NewApiKeyResult": { "NewApiKeyResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5697,6 +5737,9 @@
"language": { "language": {
"type": "string" "type": "string"
}, },
"navbar": {
"$ref": "#/definitions/NavbarPreference"
},
"queryHistory": { "queryHistory": {
"$ref": "#/definitions/QueryHistoryPreference" "$ref": "#/definitions/QueryHistoryPreference"
}, },
@ -5946,6 +5989,9 @@
"description": "Selected language (beta)", "description": "Selected language (beta)",
"type": "string" "type": "string"
}, },
"navbar": {
"$ref": "#/definitions/NavbarPreference"
},
"queryHistory": { "queryHistory": {
"$ref": "#/definitions/QueryHistoryPreference" "$ref": "#/definitions/QueryHistoryPreference"
}, },
@ -7935,6 +7981,9 @@
"language": { "language": {
"type": "string" "type": "string"
}, },
"navbar": {
"$ref": "#/definitions/NavbarPreference"
},
"queryHistory": { "queryHistory": {
"$ref": "#/definitions/QueryHistoryPreference" "$ref": "#/definitions/QueryHistoryPreference"
}, },

View File

@ -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": { "/reports/render/csvs": {
"get": { "get": {
"description": "Available to all users and with a valid license.", "description": "Available to all users and with a valid license.",
@ -8161,7 +8189,7 @@
"reports", "reports",
"enterprise" "enterprise"
], ],
"summary": "Get settings.", "summary": "Get report settings.",
"operationId": "getReportSettings", "operationId": "getReportSettings",
"responses": { "responses": {
"200": { "200": {

View File

@ -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": { "/reports/render/csvs": {
"get": { "get": {
"description": "Available to all users and with a valid license.", "description": "Available to all users and with a valid license.",
@ -21592,7 +21620,7 @@
"$ref": "#/components/responses/internalServerError" "$ref": "#/components/responses/internalServerError"
} }
}, },
"summary": "Get settings.", "summary": "Get report settings.",
"tags": [ "tags": [
"reports", "reports",
"enterprise" "enterprise"