Есть ли способ переопределить описание и пример свойств в OAS3? - PullRequest
1 голос
/ 29 мая 2019

Я искал ресурсы о наследовании в OAS3, но самое близкое, что я получил, это https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md, и выше не было ответа, который я ищу.

Это рабочий пример

components:
  schemas:
    Pet:
      properties:
        no_legs:
          description: "Number of legs"
          type: number
          example: 4
    Duck:
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            no_legs:
              example: 2
      properties:
        no_legs:
          description: 'Number of webbed feet'

Неудачный пример, который был вдохновлен спецификацией

    Duck:
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            no_legs:
              description: 'Number of webbed feet'
              example: 2

Мои вопросы

  • Является ли функция переопределения, на которую я смотрю, доступной / поддерживаемой?

  • Если да, то какой способ это сделать?

Я понял, что могу использовать композицию для решения этой проблемы, но у меня будет много повторений определения.

...