как указать, что параметр является условным, когда другой параметр используется в Swagger Open API 3.0 - PullRequest
Новая
       52

как указать, что параметр является условным, когда другой параметр используется в Swagger Open API 3.0

0 голосов
/ 01 августа 2020

Я создал RESTful API, и теперь я определяю представление Open API 3.0 JSON для использования этого API.

Я требую условного использования параметра, когда присутствует другой параметр. Поэтому я не могу использовать ни required: true, ни required: false, потому что это должно быть условным. Должен ли я просто определить, что это required: false, а затем в summary и / или description сказать, что это требуется, когда используется другой параметр? Или есть способ определить зависимость между параметрами? Я не нашел ничего в спецификациях , в которых упоминался бы такой случай.

1 Ответ

1 голос
/ 02 августа 2020

Зависимости параметров OpenAPI 3.0 не поддерживает зависимости параметров и взаимоисключающие параметры. Открытый запрос функции находится на github.com/OAI/OpenAPI-Specification/issues/256. Что вы можете сделать, так это задокументировать ограничения в описании параметра и определить logi c в ответе 400 Bad Request. Например, рассмотрим конечную точку / report, которая принимает либо относительный диапазон дат (rdate), либо точный диапазон (start_date + end_date): - Для получения дополнительной информации - swagger.io/docs/specification/describing-parameters

...