Skip to content

docs(apigw-manager): document AI gateway names #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wklken wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

docs(apigw-manager): document AI gateway names #305

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8b613c
docs(apigw-manager): document AI gateway names
wklken Aug 11, 2026
aac51dd
docs(apigw-manager): keep AI name exceptions implicit
wklken Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions sdks/apigw-manager/docs/sync_apigateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,22 @@ resource_docs:
basedir: "{{ settings.BK_APIGW_RESOURCE_DOCS_BASE_DIR }}" # 环境变量方式："{{ environ.BK_APIGW_RESOURCE_DOCS_BASE_DIR }}"
```

#### AI 网关自动化同步

自动化同步创建 AI 网关时，在 `definition.yaml` 的 `apigateway` 配置中指定 `kind: "ai"`：

```yaml
apigateway:
description: "AI 网关"
description_en: "AI Gateway"
is_public: true
kind: "ai"
maintainers:
- "admin"
```

新建 AI 网关时，通过同步命令传入的网关名称须以 `bkai-` 开头，例如 `bkai-chat`。非 AI 网关不能使用 `bkai-` 前缀；以上名称与类型约束仅在新建网关时生效，更新已有网关不受影响。

**注意：**

- 同步资源或者环境相关配置后，需要创建版本并发布才能生效，发布数据定义于 definition.yaml `release`
Expand Down
Loading