Skip to content

Conversation

@guohelu
Copy link
Collaborator

@guohelu guohelu commented Jan 14, 2026

No description provided.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

代码审查摘要

本次 PR 主要更新 API 文档,添加请求参数示例并修正格式。发现一个关键性问题需要确认:

🚨 严重问题

返回码类型变更:intstring

  • 在约 30 个 API 文档中,code 字段的类型从 int 改为 string
  • 示例值从 "code": 0 改为 "code": "0"
  • 风险:若实际 API 返回整数类型,此文档变更将导致客户端类型不匹配
  • 建议:确认后端实际返回类型,确保文档与实现一致

✨ 改进点

  1. 为多个接口补充请求参数示例(提升文档可用性)
  2. 统一 JSON 格式(移除多余空行,修正逗号位置)
  3. 完善系统变量说明文档

📋 需要确认

请验证以下 API 端点的实际返回类型(共 30+ 处变更):

  • sdk_calculate_version
  • sdk_copy_template
  • sdk_create_default_template
  • sdk_delete_snapshot
  • 以及其他所有 sdk_* 接口

建议操作

  1. 检查后端代码中 code 字段的序列化逻辑
  2. 若后端返回 int,需回退文档或修改后端实现
  3. 若后端返回 string,需确认是否有意变更并通知调用方

📌 除类型变更问题外,其他文档改进符合规范。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant