docs: add /system/cache (#25228)

This commit is contained in:
Michael Geers 2025-11-11 12:18:21 +01:00 • committed by GitHub
parent 14c1300995
commit f0887f8f5b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 69 additions and 0 deletions

View file

@ -321,6 +321,22 @@
},
"description": "Success - Soc result"
},
"SuccessResult": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"example": "OK",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"Unauthorized": {
"content": {
"text/plain": {
@ -2041,6 +2057,29 @@
]
}
},
"/system/cache": {
"delete": {
"description": "Clears all cached data. This resets all cached values from tariffs, vehicle APIs, and other components that use caching.",
"operationId": "clearCache",
"responses": {
"200": {
"$ref": "#/components/responses/SuccessResult"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"security": [
{
"cookieAuth": []
}
],
"summary": "Clear cache",
"tags": [
"system"
]
}
},
"/system/log": {
"get": {
"description": "Returns the latest log lines.",

View file

@ -906,6 +906,12 @@ call updateSession {
}
```
## clearCache
Clears all cached data. This resets all cached values from tariffs, vehicle APIs, and other components that use caching.
**Tags:** system
## getLogAreas
Returns a list of all log areas (e.g. `lp-1`, `site`, `db`).

View file

@ -891,6 +891,20 @@ paths:
$ref: "#/components/schemas/LogAreas"
"401":
$ref: "#/components/responses/Unauthorized"
/system/cache:
delete:
operationId: clearCache
summary: Clear cache
description: "Clears all cached data. This resets all cached values from tariffs, vehicle APIs, and other components that use caching."
security:
- cookieAuth: []
tags:
- system
responses:
"200":
$ref: "#/components/responses/SuccessResult"
"401":
$ref: "#/components/responses/Unauthorized"
/system/shutdown:
post:
operationId: shutdownSystem
@ -1517,6 +1531,16 @@ components:
type: "object"
BlankResponse:
description: Success - Blank response
SuccessResult:
description: Success
content:
application/json:
schema:
type: object
properties:
result:
type: string
example: "OK"
EmptyResult:
description: Success - Empty result
content: