diff --git a/docs/api.md b/docs/api.md index dcc6f83..debef1c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -58,6 +58,7 @@ - [ConfigSystem](#api-v1-ConfigSystem) - [Configs](#api-v1-Configs) - [EnvDependent](#api-v1-EnvDependent) + - [Envs](#api-v1-Envs) - [ListConfigRequest](#api-v1-ListConfigRequest) - [Settings](#api-v1-Settings) - [Stats](#api-v1-Stats) @@ -898,6 +899,7 @@ | enable_captcha_find_password | [bool](#bool) | | | | enable_captcha_upload | [bool](#bool) | | | | max_document_size | [int32](#int32) | | | +| document_allowed_ext | [string](#string) | repeated | | @@ -925,6 +927,7 @@ | register_background | [string](#string) | | | | login_background | [string](#string) | | | | recommend_words | [string](#string) | repeated | | +| version | [string](#string) | | 程序版本号 | @@ -959,6 +962,23 @@ | is_installed | [bool](#bool) | | 是否已安装 | | error | [string](#string) | | 错误信息 | | checked_at | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | 检测时间 | +| cmd | [string](#string) | | 检测命令 | +| is_required | [bool](#bool) | | 是否必须 | + + + + + + + + +### Envs + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| envs | [EnvDependent](#api-v1-EnvDependent) | repeated | | @@ -1017,7 +1037,6 @@ | hash | [string](#string) | | | | build_at | [string](#string) | | | | report_count | [int64](#int64) | | | -| envs | [EnvDependent](#api-v1-EnvDependent) | repeated | | @@ -1041,6 +1060,7 @@ | UpdateConfig | [Configs](#api-v1-Configs) | [.google.protobuf.Empty](#google-protobuf-Empty) | UpdateConfig 更新配置 | | ListConfig | [ListConfigRequest](#api-v1-ListConfigRequest) | [Configs](#api-v1-Configs) | ListConfig 查询配置项 | | GetStats | [.google.protobuf.Empty](#google-protobuf-Empty) | [Stats](#api-v1-Stats) | 获取系统配置 | +| GetEnvs | [.google.protobuf.Empty](#google-protobuf-Empty) | [Envs](#api-v1-Envs) | 获取系统环境依赖检测 | | UpdateSitemap | [.google.protobuf.Empty](#google-protobuf-Empty) | [.google.protobuf.Empty](#google-protobuf-Empty) | 更新站点地图 | @@ -2355,6 +2375,7 @@ | sign_at | [int32](#int32) | | | | ip | [string](#string) | | | | created_at | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| award | [int32](#int32) | | 签到积分奖励 | diff --git a/docs/images/index.png b/docs/images/index.png index 6a183e8..d56d42e 100644 Binary files a/docs/images/index.png and b/docs/images/index.png differ diff --git a/docs/openapi.yaml b/docs/openapi.yaml index f7e7ba4..6f82cd3 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -2043,6 +2043,25 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' + /api/v1/envs: + get: + tags: + - ConfigAPI + description: 获取系统环境依赖检测 + operationId: ConfigAPI_GetEnvs + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Envs' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' /api/v1/favorite: get: tags: @@ -3445,6 +3464,10 @@ components: maxDocumentSize: type: integer format: int32 + documentAllowedExt: + type: array + items: + type: string description: 安全配置 ConfigSystem: type: object @@ -3477,6 +3500,8 @@ components: type: array items: type: string + version: + type: string description: 系统配置项 Configs: type: object @@ -3677,6 +3702,17 @@ components: checkedAt: type: string format: date-time + cmd: + type: string + isRequired: + type: boolean + Envs: + type: object + properties: + envs: + type: array + items: + $ref: '#/components/schemas/EnvDependent' Favorite: type: object properties: @@ -4111,6 +4147,9 @@ components: createdAt: type: string format: date-time + award: + type: integer + format: int32 Stats: type: object properties: @@ -4146,10 +4185,6 @@ components: reportCount: type: integer format: int64 - envs: - type: array - items: - $ref: '#/components/schemas/EnvDependent' Status: type: object properties: