Описание перегрузки в файле Swagger (YAML)

У меня проблема с записью файла swagger. Когда я описываю параметр, описание перегружается описанием $ref этого же параметра (см. пример ниже).

a-body:
    description: The body
    type: object
    properties:
      my_param:
        description: Full description 
        $ref: '#/definitions/reference'

definitions:
    reference:
        type: object
        required: [req]
        description: an http reference
        properties:
          req:
            type: string

Результат: описание перегружено

Может кто-нибудь помочь мне пройти через это, пожалуйста?


yaml swagger swagger-2.0 swagger-editor
person VisualPi    schedule 07.11.2017    source источник

Ответы (1)


arrow_upward
1
arrow_downward

$ref перезаписывает все свои родственные свойства — так работает $ref. Вы можете попытаться обойти это, используя что-то вроде:

my_param:
  description: Full description 
  allOf:
    - $ref: '#/definitions/reference'

Это будет работать в редакторе Swagger и пользовательском интерфейсе Swagger.

В репозитории спецификаций OpenAPI также есть запрос функции, чтобы предоставить лучший способ объединить $ref с другими свойствами.

person Helen    schedule 07.11.2017
comment
Я использую глючный плагин для кода vs, поэтому он не работает, но я не могу иначе! Спасибо за вашу помощь ! - person VisualPi; 07.11.2017