Можно ли определить поле в swagger, которое содержит конкретные значения

Мой API содержит поле result который имеет тип string но он может содержать только одно из следующих значений - success или же error, Как я мог определить это в Swagger?

Вместо того чтобы сказать

ServerResponse: #{result: ..., additional-info: ...}
      type: object
      properties: 
        result: 
          type: string #generic type, could be any string
        additional-info: 
          type: string
      required:
        - result
        - additional-info

я хочу сказать

ServerResponse: #{result: ..., additional-info: ...}
      type: object
      properties: 
        result: 
          type: 'success' or 'error'#<-- something like this with specific list of possible value
        additional-info: 
          type: string
      required:
        - result
        - additional-info

0 ответов

Другие вопросы по тегам