Взаимоисключающие свойства в чванстве

Вы можете переключиться на OpenAPI 3.0, который поддерживает ключевое слово oneOf для определения взаимоисключающих условий:

вот пример:

 my_object:
 type: object
 properties:
   property_1:
     type: string
   property_2:
    type: integer
 oneOf:
- required: [property_1]
- required: [property_2]

В OpenAPI 3.0 (openapi: 3.0.0) вы можете использовать ключевое слово oneOf для определения взаимоисключающих условий. Эта схема требует, чтобы присутствовал либо property_1, либо property_2, но не оба:

my_object:
  type: object
  properties:
    property_1:
      type: string
    property_2:
      type: string
    property_3:
      type: string
  oneOf:
    - required: [property_1]
    - required: [property_2]

Если хотя бы один этих двух свойств должен присутствовать, используйте вместо этого anyOf.

Примечание: Хотя oneOf является частью спецификации OpenAPI (например, вы можете писать определения API, включающие oneOf), фактическая инструментальная поддержка oneOf может различаться и быть ограниченной.

Если вы используете OpenAPI 2.0 (swagger: "2.0"), он не поддерживает oneOf, поэтому вы можете документировать это условие только устно в описании схемы или описаниях свойств.