javascript - json-schema 附加元数据

Question

可以向 json 架构属性添加额外的或自定义的元数据(标题和描述除外)吗？

理想情况下，我想像这样添加一些元数据:

//...
"properties": {
  "contactFullName": {
    "$ref": "#/definitions/fullName",
    "custom": "my custom metadata here"
  }
}
//...

你能在 definitions 中添加一些东西来允许吗？

Answer 1

您无需执行任何特殊操作即可使用其他元数据关键字。你可以只使用它们。在 JSON Schema 中，包含未定义的关键字不是错误。任何没有 JSON Schema 语义的东西都应该被悄悄地忽略。因此，以下模式是完全有效的，不应与任何验证器实现冲突。

{
  "title": "Foo",
  "description": "All the foo you can GET",
  "version": "1.0.3",
  "author": "Jason Desrosiers",
  "type": "object",
  "properties": {
    "id": { "type": "string" }
  }
}