OpenApi - 如何指定具有未知属性名称的响应 json

Question

我有一个 API，可以根据请求返回数据行。这些行是包含名称：值对的 JSON 元素。但是，属性名称（以及值的数据类型）需要灵活且在规范中未定义。

例如：

{
    "row_id": 1234,
    "data": {
        "foo": "bar",
        "date": "2019-07-31",
        "some_number": 5
    }
 }

在此示例中，属性“row_id”和“data”是唯一固定的内容。元素内的所有名称：值对data可以是任何内容。

我相信我可以使用 open apiadditionalProperties来描述这一点，但我找不到任何示例来告诉我如何或确认这是正确的。

有谁知道如何做到这一点或者可以为我指明正确的方向？

Answer 1

看起来我正在寻找的是：

    recordData:
      type: object
      additionalProperties: {}

type: object将其定义为一般对象，并additionalProperties: {}表示该对象包含尚未专门定义的属性。

我最终找到的文档也说这additionalProperties: true也可行。