Описать кодировку с разделителями каналов в объекте в теле ответа в Open API 3.0 - PullRequest
1 голос
/ 03 августа 2020

Так что, возможно, я пытаюсь go слишком подробно описать свой дескриптор, но вот мой вариант использования. При определении схемы объекта, который возвращается в теле ответа для моего API, у меня есть одно свойство объекта, значение которого является объектом с переменными свойствами, поэтому я использую дескриптор additionalProperties.

{
  "type": "object",
  "additionalProperties": {
    "type": "string"
  }
}

Однако вместо того, чтобы описывать type значений в этом объекте с переменным ключом как string, я хотел бы описать их более точно, поскольку строка на самом деле представляет собой сериализацию массива с разделителями каналов. Пример:

{
  "property1": {
    "variableProperty1": "info1|info2|info3",
    "variableProperty2": "info1|info2|info3"
  }
}

Есть ли способ описать эту сериализацию с разделителями каналов? Примерно так:

{
  "type": "object",
  "additionalProperties": {
    "type": "array",
    "explode": false,
    "encoding": {
      "style": "pipeDelimited"
    }
  },
}

Или это возможно только для параметров запроса ?

...