Swagger - указать ответ массива с постоянным набором значений - PullRequest
0 голосов
/ 10 января 2020

У меня есть поле выбора (несколько вариантов) во внешнем интерфейсе, для которого я хочу, чтобы бэкэнд-API возвращал набор значений для отображения в select, а также в выбранных значениях.

Я создал следующую спецификацию API в Swagger.

    languageSelect:
      type: object
      properties:
        options:
          type: array
          description: return all the options
          items:
            type: string
            enum: [en, fr, ja, zh]
        selected:
          type: array
          description: return only the options selected
          items:
            type: string
            enum: [en, fr, ja, zh]

В этом фрагменте spe c для всех опций и выбранных опций одинакова, кроме описания. Но если я опущу описание, то можно отправить обратно только одно значение в качестве ответа в поле options.

Есть ли лучший способ написать это в Swagger, который гарантирует, что возвращается постоянный набор значений?

...