feat(tenant): optional legacy auto-create API key on tenant creation
Add a tenant.auto_create_api_key setting (env WEKNORA_TENANT_AUTO_CREATE_API_KEY, default false) that restores the pre-break-change behaviour of minting a full_access API key when a tenant is created and returning its plaintext token in the create response (data.api_key). - system_setting: register tenant.auto_create_api_key bool spec - handler: gate auto key creation behind the setting; embed the token via tenantWithAPIKey without re-adding a persisted api_key column; key-creation failures log a warning and do not fail tenant creation - client: add optional Tenant.APIKey field populated only on create - docs/env: document the switch (.env.example, docker-compose, tenant.md, regenerated swagger)
This commit is contained in:
+25
-3
@@ -110,7 +110,9 @@ curl --location 'http://localhost:8080/api/v1/tenants/search?keyword=weknora&pag
|
||||
|
||||
## POST `/tenants` - 创建新租户
|
||||
|
||||
创建一个新的租户。**不会**自动发放 API Key;请在创建后通过 `POST /tenants/:id/api-keys` 创建密钥。从旧版本升级时,原有 `tenants.api_key` 会迁移到 `tenant_api_keys` 表并继续可用,直至被吊销。
|
||||
创建一个新的租户。**默认不会**自动发放 API Key;请在创建后通过 `POST /tenants/:id/api-keys` 创建密钥。从旧版本升级时,原有 `tenants.api_key` 会迁移到 `tenant_api_keys` 表并继续可用,直至被吊销。
|
||||
|
||||
> **兼容旧行为(可选)**:如需恢复旧版「创建租户即下发默认 API Key」的行为,可将系统设置 `tenant.auto_create_api_key` 置为 `true`(或设置环境变量 `WEKNORA_TENANT_AUTO_CREATE_API_KEY=true`)。开启后,创建租户会自动生成一个 `full_access` 权限的 API Key,并在响应体 `data.api_key` 中返回其明文 token(仅本次创建响应返回,请妥善保存)。默认 `false`。
|
||||
|
||||
**参数说明(请求体)**:
|
||||
|
||||
@@ -146,7 +148,7 @@ curl --location 'http://localhost:8080/api/v1/tenants' \
|
||||
}'
|
||||
```
|
||||
|
||||
**响应**:
|
||||
**响应**(默认,不含 API Key):
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -154,7 +156,6 @@ curl --location 'http://localhost:8080/api/v1/tenants' \
|
||||
"id": 10000,
|
||||
"name": "weknora",
|
||||
"description": "weknora tenants",
|
||||
"api_key": "sk-aaLRAgvCRJcmtiL2vLMeB1FB5UV0Q-qB7DlTE1pJ9KA93XZG",
|
||||
"status": "active",
|
||||
"retriever_engines": {
|
||||
"engines": [
|
||||
@@ -179,6 +180,27 @@ curl --location 'http://localhost:8080/api/v1/tenants' \
|
||||
}
|
||||
```
|
||||
|
||||
当开启 `tenant.auto_create_api_key`(或 `WEKNORA_TENANT_AUTO_CREATE_API_KEY=true`)时,响应的 `data` 中会额外包含 `api_key` 字段(`full_access` 密钥的明文 token):
|
||||
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"id": 10000,
|
||||
"name": "weknora",
|
||||
"description": "weknora tenants",
|
||||
"api_key": "sk-aaLRAgvCRJcmtiL2vLMeB1FB5UV0Q-qB7DlTE1pJ9KA93XZG",
|
||||
"status": "active",
|
||||
"business": "wechat",
|
||||
"storage_quota": 10737418240,
|
||||
"storage_used": 0,
|
||||
"created_at": "2025-08-11T20:37:28.396980093+08:00",
|
||||
"updated_at": "2025-08-11T20:37:28.396980301+08:00",
|
||||
"deleted_at": null
|
||||
},
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
## GET `/tenants/:id` - 获取指定租户信息
|
||||
|
||||
获取指定 ID 的租户详情。只能访问自己所属租户;访问其他租户需要跨租户权限,否则返回 403。
|
||||
|
||||
+64
-2
@@ -3956,6 +3956,50 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/knowledge-bases/{id}/duplicate": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个只包含设置的新知识库副本,不复制知识、FAQ 内容、分块、索引、Wiki 页面、分享或置顶状态",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"知识库"
|
||||
],
|
||||
"summary": "创建知识库副本",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "源知识库 ID",
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "创建后的知识库副本",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "请求参数错误",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/knowledge-bases/{id}/faq/entries": {
|
||||
"get": {
|
||||
"security": [
|
||||
@@ -11494,7 +11538,7 @@ const docTemplate = `{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "创建新的租户。任意已登录用户均可调用以建立自己的新工作区,\n调用方会被自动设为该租户的 Owner。跨租户超管仍可像以前一样\n通过本接口创建任意租户。",
|
||||
"description": "创建新的租户。任意已登录用户均可调用以建立自己的新工作区,\n调用方会被自动设为该租户的 Owner。跨租户超管仍可像以前一样\n通过本接口创建任意租户。\n当 tenant.auto_create_api_key(或 WEKNORA_TENANT_AUTO_CREATE_API_KEY)\n开启时,会自动创建一个 full_access API Key,并在响应体的 data.api_key 字段返回其明文 token。",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -11518,7 +11562,7 @@ const docTemplate = `{
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "创建的租户",
|
||||
"description": "创建的租户(可选含 api_key)",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
@@ -16198,6 +16242,10 @@ const docTemplate = `{
|
||||
"interface_type": {
|
||||
"type": "string"
|
||||
},
|
||||
"max_concurrency": {
|
||||
"description": "MaxConcurrency caps concurrent in-flight BACKGROUND (ingestion /\nenrichment) calls to THIS specific model, keyed by model ID and shared\nacross all replicas. 0 (the default) means \"fall back to the\nprocess-wide model.max_concurrency\". Interactive user-facing calls are\nnever gated. Only chat / vlm / embedding honour this (see limiter.Gate).",
|
||||
"type": "integer"
|
||||
},
|
||||
"parameter_size": {
|
||||
"description": "Ollama model parameter size (e.g., \"7B\", \"13B\", \"70B\")",
|
||||
"type": "string"
|
||||
@@ -20348,9 +20396,23 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mentioned_items": {
|
||||
"description": "Optional scoped tag mentions",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/internal_handler_session.MentionedItemRequest"
|
||||
}
|
||||
},
|
||||
"query": {
|
||||
"description": "Query text to search for",
|
||||
"type": "string"
|
||||
},
|
||||
"tag_ids": {
|
||||
"description": "Tag IDs for filtering within a single KB",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
+64
-2
@@ -3949,6 +3949,50 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/knowledge-bases/{id}/duplicate": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个只包含设置的新知识库副本,不复制知识、FAQ 内容、分块、索引、Wiki 页面、分享或置顶状态",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"知识库"
|
||||
],
|
||||
"summary": "创建知识库副本",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "源知识库 ID",
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "创建后的知识库副本",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "请求参数错误",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/knowledge-bases/{id}/faq/entries": {
|
||||
"get": {
|
||||
"security": [
|
||||
@@ -11487,7 +11531,7 @@
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "创建新的租户。任意已登录用户均可调用以建立自己的新工作区,\n调用方会被自动设为该租户的 Owner。跨租户超管仍可像以前一样\n通过本接口创建任意租户。",
|
||||
"description": "创建新的租户。任意已登录用户均可调用以建立自己的新工作区,\n调用方会被自动设为该租户的 Owner。跨租户超管仍可像以前一样\n通过本接口创建任意租户。\n当 tenant.auto_create_api_key(或 WEKNORA_TENANT_AUTO_CREATE_API_KEY)\n开启时,会自动创建一个 full_access API Key,并在响应体的 data.api_key 字段返回其明文 token。",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -11511,7 +11555,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "创建的租户",
|
||||
"description": "创建的租户(可选含 api_key)",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
@@ -16191,6 +16235,10 @@
|
||||
"interface_type": {
|
||||
"type": "string"
|
||||
},
|
||||
"max_concurrency": {
|
||||
"description": "MaxConcurrency caps concurrent in-flight BACKGROUND (ingestion /\nenrichment) calls to THIS specific model, keyed by model ID and shared\nacross all replicas. 0 (the default) means \"fall back to the\nprocess-wide model.max_concurrency\". Interactive user-facing calls are\nnever gated. Only chat / vlm / embedding honour this (see limiter.Gate).",
|
||||
"type": "integer"
|
||||
},
|
||||
"parameter_size": {
|
||||
"description": "Ollama model parameter size (e.g., \"7B\", \"13B\", \"70B\")",
|
||||
"type": "string"
|
||||
@@ -20341,9 +20389,23 @@
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mentioned_items": {
|
||||
"description": "Optional scoped tag mentions",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/internal_handler_session.MentionedItemRequest"
|
||||
}
|
||||
},
|
||||
"query": {
|
||||
"description": "Query text to search for",
|
||||
"type": "string"
|
||||
},
|
||||
"tag_ids": {
|
||||
"description": "Tag IDs for filtering within a single KB",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
+49
-1
@@ -2061,6 +2061,14 @@ definitions:
|
||||
type: object
|
||||
interface_type:
|
||||
type: string
|
||||
max_concurrency:
|
||||
description: |-
|
||||
MaxConcurrency caps concurrent in-flight BACKGROUND (ingestion /
|
||||
enrichment) calls to THIS specific model, keyed by model ID and shared
|
||||
across all replicas. 0 (the default) means "fall back to the
|
||||
process-wide model.max_concurrency". Interactive user-facing calls are
|
||||
never gated. Only chat / vlm / embedding honour this (see limiter.Gate).
|
||||
type: integer
|
||||
parameter_size:
|
||||
description: Ollama model parameter size (e.g., "7B", "13B", "70B")
|
||||
type: string
|
||||
@@ -5123,9 +5131,19 @@ definitions:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
mentioned_items:
|
||||
description: Optional scoped tag mentions
|
||||
items:
|
||||
$ref: '#/definitions/internal_handler_session.MentionedItemRequest'
|
||||
type: array
|
||||
query:
|
||||
description: Query text to search for
|
||||
type: string
|
||||
tag_ids:
|
||||
description: Tag IDs for filtering within a single KB
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- query
|
||||
type: object
|
||||
@@ -7609,6 +7627,34 @@ paths:
|
||||
summary: 更新知识库
|
||||
tags:
|
||||
- 知识库
|
||||
/knowledge-bases/{id}/duplicate:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: 创建一个只包含设置的新知识库副本,不复制知识、FAQ 内容、分块、索引、Wiki 页面、分享或置顶状态
|
||||
parameters:
|
||||
- description: 源知识库 ID
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
type: string
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"201":
|
||||
description: 创建后的知识库副本
|
||||
schema:
|
||||
additionalProperties: true
|
||||
type: object
|
||||
"400":
|
||||
description: 请求参数错误
|
||||
schema:
|
||||
$ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError'
|
||||
security:
|
||||
- Bearer: []
|
||||
summary: 创建知识库副本
|
||||
tags:
|
||||
- 知识库
|
||||
/knowledge-bases/{id}/faq/entries:
|
||||
delete:
|
||||
consumes:
|
||||
@@ -12490,6 +12536,8 @@ paths:
|
||||
创建新的租户。任意已登录用户均可调用以建立自己的新工作区,
|
||||
调用方会被自动设为该租户的 Owner。跨租户超管仍可像以前一样
|
||||
通过本接口创建任意租户。
|
||||
当 tenant.auto_create_api_key(或 WEKNORA_TENANT_AUTO_CREATE_API_KEY)
|
||||
开启时,会自动创建一个 full_access API Key,并在响应体的 data.api_key 字段返回其明文 token。
|
||||
parameters:
|
||||
- description: 租户信息
|
||||
in: body
|
||||
@@ -12501,7 +12549,7 @@ paths:
|
||||
- application/json
|
||||
responses:
|
||||
"201":
|
||||
description: 创建的租户
|
||||
description: 创建的租户(可选含 api_key)
|
||||
schema:
|
||||
additionalProperties: true
|
||||
type: object
|
||||
|
||||
Reference in New Issue
Block a user