OpenApi 3.0.0 - как указать ответ json с неизвестными именами атрибутов

Question

У меня есть API, который возвращает строки данных на основе запроса. Строки являются JSON элементами, содержащими пары имя: значение. Однако имена атрибутов (и типы данных значений) должны быть плавными и неопределенными в spe c.

Например:

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

В этом примере атрибуты ' row_id 'и' data '- единственные фиксированные вещи. Все пары name: values ​​внутри элемента data могут быть любыми.

Я полагаю, что могу использовать open api additionalProperties, чтобы описать это, но ни один пример, который я могу найти, не подскажет мне, как или подтвердить, что это правильно.

Кто-нибудь знает, как это сделать, или может указать мне правильное направление?

Answer 1

Похоже, что я искал:

    recordData:
      type: object
      additionalProperties: {}

type: object определяет его как общий объект, а additionalProperties: {} говорит, что объект содержит свойства, которые не были специально определены.

Документы, которые я наконец нашел, также говорят, что additionalProperties: true также будет работать.