Skip to content

docs: update skill list front matter response #1130

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

Open
jay666mnj wants to merge 1 commit into
base: develop-astro-nacos
Choose a base branch
from
Open

docs: update skill list front matter response #1130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/content/docs/next/en/manual/user/ai/skill-registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ The list page displays all Skills in card format with the following features:

- **Search**: Search by Skill name keyword
- **Sort**: Sort by default order or download count
- **Card Info**: Displays name, description, business tags, online version count, draft status, download count, and update time
- **Card Info**: Displays name, description, business tags, online version count, draft status, download count, and update time; the list API also returns `frontMatter` parsed from the display version's `SKILL.md`, which can be used to show custom metadata such as `alias`
- **Batch Operations**: Multi-select for batch deletion
- **Quick Actions**: Upload ZIP, create new Skill

Expand Down Expand Up @@ -259,6 +259,8 @@ Skill Registry provides three layers of REST APIs:
| **Console API** | Console operations (requires login authentication) | [Console API - Skills](../../admin/console-api.md) |
| **Admin API** | Cluster internal management interface | [Admin API - AI Skills](../../admin/admin-api.md) |

For Skill list queries, each response item contains a `frontMatter` field with key-value pairs parsed from the display version's `SKILL.md` YAML front matter. This field may be empty when the version is unavailable, `SKILL.md` has no front matter, or parsing fails.

### 4.3. Java SDK

Nacos provides two Java SDKs for programmatic Skill management:
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/next/zh-cn/manual/user/ai/skill-registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Nacos 控制台提供了完整的 Skill 管理界面，位于 **AI 注册中心

- **搜索**：按 Skill 名称关键字搜索
- **排序**：支持按默认排序或下载量排序
- **卡片信息**：显示名称、描述、业务标签、在线版本数、是否有草稿、下载量、更新时间
- **卡片信息**：显示名称、描述、业务标签、在线版本数、是否有草稿、下载量、更新时间；列表接口同时返回展示版本 `SKILL.md` 中解析出的 `frontMatter`，可用于展示 `alias` 等自定义元数据
- **批量操作**：支持多选后批量删除
- **快捷入口**：上传 ZIP、创建新 Skill

Expand Down Expand Up @@ -259,6 +259,8 @@ Skill 管理提供三层 REST API：
| **Console API** | 控制台管理操作（需登录认证） | [控制台API - Skills 管理](../../admin/console-api.md#7-skills-管理) |
| **Admin API** | 集群内部管理接口 | [运维API - AI Skills 管理](../../admin/admin-api.md#7-ai-skills-管理) |

其中，Skill 列表查询的返回项包含 `frontMatter` 字段，内容为展示版本 `SKILL.md` YAML front matter 解析后的键值对；当对应版本不存在、`SKILL.md` 无 front matter 或解析失败时，该字段可能为空。

### 4.3. Java SDK

Nacos 提供两种 Java SDK 用于 Skill 的程序化管理：
Expand Down