From c337e194655d500687f18a3194d6a56ec1a54b39 Mon Sep 17 00:00:00 2001 From: lifegpc Date: Mon, 6 Jan 2025 18:31:46 +0800 Subject: [PATCH] doc: Update document --- README.md | 5 +++- api.yml | 68 +++++++++++++++++++++++++++---------------------------- 2 files changed, 37 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 212705c..d81f67d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ curl -L "https://github.com/lifegpc/eh-downloader/raw/master/docker-compose.yml" 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 diff --git a/api.yml b/api.yml index 0601dfc..6d2b93a 100644 --- a/api.yml +++ b/api.yml @@ -2610,41 +2610,39 @@ paths: delete: operationId: clearLog summary: Clear log - parameters: - - name: type - in: query - schema: - type: string - description: Log type filter - - name: min_level - in: query - schema: - $ref: "#/components/schemas/LogLevel" - description: Minimum log level filter - - name: max_level - in: query - schema: - $ref: "#/components/schemas/LogLevel" - description: Maximum log level filter - - name: deleted_level - in: query - schema: - type: array - items: - type: integer - description: List of log levels to delete - - name: end_time - in: query - schema: - type: string - format: date-time - description: End time for log deletion - - name: optimize - in: query - schema: - type: boolean - default: true - description: Whether to optimize the log after clearing + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + type: + type: string + description: Log type filter + default: '' + min_level: + $ref: "#/components/schemas/LogLevel" + description: Minimum log level filter + default: '' + max_level: + $ref: "#/components/schemas/LogLevel" + description: Maximum log level filter + default: '' + deleted_level: + type: array + items: + type: integer + description: List of log levels to delete + default: [] + end_time: + type: string + format: date-time + description: End time for log deletion + default: '' + optimize: + type: boolean + default: true + description: Whether to optimize the log after clearing responses: "200": description: OK