CODEWITHSUNDEEP
swaggeropenapi
Andres
Andres

Reputation: 10707

Mutually excluding properties in swagger

How do I indicate that in my_object you can have property_1 or property_2, but not both, and at least one of them must be present?

my_object:
  type: object
  properties:
    property_1:
      type: string
    property_2:
      type: string

Upvotes: 4

Views: 7456

Answers (2)

Helen
Helen

Reputation: 97540

In OpenAPI 3.0 (openapi: 3.0.0), you can use the oneOf keyword to define mutually exclusive conditions. This schema requires that either property_1 or property_2 be present, but not both:

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

If at least one of these two properties must be present, use anyOf instead.

Note: While oneOf is part of the OpenAPI Specification (as in, you can write API definitions that include oneOf), actual tooling support for oneOf may vary and be limited.


If you use OpenAPI 2.0 (swagger: "2.0"), it does not support oneOf, so you can only document this condition verbally in the schema description or property descriptions.

Upvotes: 3

Kakashi
Kakashi

Reputation: 309

You may want to switch to OpenAPI 3.0, which supports oneOf keyword to define mutually exclusive conditions:

here is an example :

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

Upvotes: 3

Related Questions