doc: Update document

This commit is contained in:
2025-01-06 18:31:46 +08:00
parent dd9e694ca3
commit c337e19465
2 changed files with 37 additions and 36 deletions

View File

@@ -7,7 +7,10 @@ curl -L "https://github.com/lifegpc/eh-downloader/raw/master/docker-compose.yml"
docker compose up -d docker compose up -d
``` ```
API Document is available [here](https://ehapi.lifegpc.com/). Now dashboard is available at `http://localhost:8000`. API Document is available
at `http://localhost:8000/swagger`
API Document is also available [here](https://ehapi.lifegpc.com/).
## Official Frontend ## Official Frontend

34
api.yml
View File

@@ -2610,38 +2610,36 @@ paths:
delete: delete:
operationId: clearLog operationId: clearLog
summary: Clear log summary: Clear log
parameters: requestBody:
- name: type content:
in: query application/x-www-form-urlencoded:
schema: schema:
type: object
properties:
type:
type: string type: string
description: Log type filter description: Log type filter
- name: min_level default: ''
in: query min_level:
schema:
$ref: "#/components/schemas/LogLevel" $ref: "#/components/schemas/LogLevel"
description: Minimum log level filter description: Minimum log level filter
- name: max_level default: ''
in: query max_level:
schema:
$ref: "#/components/schemas/LogLevel" $ref: "#/components/schemas/LogLevel"
description: Maximum log level filter description: Maximum log level filter
- name: deleted_level default: ''
in: query deleted_level:
schema:
type: array type: array
items: items:
type: integer type: integer
description: List of log levels to delete description: List of log levels to delete
- name: end_time default: []
in: query end_time:
schema:
type: string type: string
format: date-time format: date-time
description: End time for log deletion description: End time for log deletion
- name: optimize default: ''
in: query optimize:
schema:
type: boolean type: boolean
default: true default: true
description: Whether to optimize the log after clearing description: Whether to optimize the log after clearing