guide错误

CKEditor 协作服务器 REST API 使用标准 HTTP 响应代码。

# 错误主体

每个错误都有以下字段

  • message – 包含简短的错误描述。
  • status_code – 包含响应状态。
  • trace_id – 是唯一的请求标识符。
  • data – 可能包含各种信息,并且根据端点的不同而有不同的结构。
  • explanation – 包含有关特定错误发生原因的解释。
  • action – 如果某些操作可以解决问题,则包含对应该执行的操作的描述。

# 示例

所呈现的错误是一个示例,它可能在将评论导入到给定文档时发生,但评论已导入。

{
  "message": "The target document already contains an import of the comments but it is based on a different snapshot.",
  "traceId": "e5abd738-db35-4372-b1de-cff9b48cc311",
  "statusCode": 409,
  "explanation": "A single target document cannot contain multiple imports of the same source.",
  "action": "Use a different target document ID.",
  "data": {
    "documentId": "doc-1",
    "importSnapshotAt": "2022-10-19T11:12:21.357Z"
  }
}