[docs] Improve Documentation - Admin API / 文档完善（Admin API 文档）

[hui-cha]

[docs] Improve Documentation - Admin API / 文档完善（Admin API 文档）

---

English Version

Background

SOFARegistry lacks comprehensive documentation for its Admin API. This makes it difficult for developers and operators to understand the system's capabilities and troubleshoot issues effectively.

Goal

Improve SOFARegistry documentation to help developers and operators:

• Understand and use Admin APIs effectively
• Troubleshoot issues with clear API documentation

Scope

This issue focuses on Admin API documentation.

In Scope:

• Admin API documentation (Markdown format)
• Request/response examples for each API
• Parameter descriptions and error codes

Out of Scope:

• Code implementation changes
• New API development
• Deployment guides
• Architecture diagrams

Suggested Tasks

1. Admin API Documentation

   • Inventory existing HTTP API endpoints
   • Document request/response examples for each endpoint
   • Add parameter descriptions
   • Document error codes
   • Describe use cases

2. Format

   • All documentation in Markdown format

Deliverables

• Admin API documentation (Markdown)

Resources

• SOFARegistry GitHub: https://github.com/sofastack/sofa-registry
• Current documentation: https://www.sofastack.tech/projects/sofa-registry/

Difficulty

Level	Medium/Hard
AI-friendly	Yes
Good for beginners	Yes

Labels

documentation, good first issue, AI-friendly

---

中文版本

背景

SOFARegistry 缺乏关于 Admin API 的全面文档。这使得开发者和运维人员难以理解系统功能和有效排查问题。

目标

改进 SOFARegistry 文档，帮助开发者和运维人员：

• 理解并有效使用 Admin API
• 通过清晰的 API 文档排查问题

范围

本 issue 专注于Admin API 文档。

包含：

• Admin API 文档（Markdown 格式）
• 每个 API 的请求/响应示例
• 参数说明和错误码

不包含：

• 代码实现变更
• 新 API 开发
• 部署指南
• 架构图

建议任务

1. Admin API 文档

   • 整理现有的 HTTP API 接口列表
   • 为每个接口编写请求/响应示例
   • 添加参数说明
   • 整理错误码
   • 说明使用场景

2. 格式

   • 所有文档使用 Markdown 格式

交付物

• Admin API 文档（Markdown）

资源

• SOFARegistry GitHub: https://github.com/sofastack/sofa-registry
• 当前文档：https://www.sofastack.tech/projects/sofa-registry/

难度

难度	中等/困难
AI 友好	是
新手友好	是

标签

documentation, good first issue, AI-friendly