enums - 在 json 模式中，如何定义一个枚举并描述枚举中的每个元素？

Question

在 json 模式中，我可以使用“枚举”和可用代码列表简单地定义一个代码列表，例如:

{
  "type": "object",
  "properties": {
    "group": {
      "type":"string",  
      "$ref": "#/definitions/Group"
    }
  },

  "definitions": {
    "Group": {
      "enum": ["A","B"]
    }
  }
}

下面的有效负载是有效的:

{
  "group": "B"
}

但是，我尝试向用户提供架构中的描述，其中“A”=“A 组”，“B”=“B 组”。像这样的东西:

{
  "type": "object",
  "properties": {
    "group": {
      "type":"string",  
      "$ref": "#/definitions/Group"
    }
  },

  "definitions": {
    "Group": {
      "enum": [
        {"code":"A",
         "description": "Group A"
        },
        {"code":"B",
         "description": "Group B"
        }
      ]
    }
  }
}

但我不想更改有效负载的结构(不需要“描述”字段)描述更多的是为了用户可以引用的文档目的。有什么好的做法可以用在这里吗？

谢谢

Answer 1

您可以使用 anyOf 和 const 而不是 enum。然后您可以使用 title 或 description 作为文档。

{
  "anyOf": [
    {
      "const": "A",
      "title": "Group A"
    },
    {
      "const": "B",
      "title": "Group B"
    }
  ]
}