如何为可选枚举定义编写swagger文档？

Question

我有一个类似于

的API

public Optional<Status> getStatus

但无法弄清楚swagger规范的定义应该如何。以下swagger.io编辑器错误消息并不重要：

get:
  ...
  responses:
    '200':
      description: OK
      schema:
        $ref: '#/definitions/Status'

definitions:
  Status:
    properties:
      type: string
      description: Blah
      enum:
        - UNKNOWN

Answer 1

只是外部'属性'属性导致问题（作为字符串而不是对象）：

definitions:
  Status:
    type: string
    description: Blah
    enum:
      - UNKNOWN