Как сослаться на ту же схему, что и на свойство?

В моем файле oas.yaml есть следующее:

components:
  schemas:
    ServiceError:
      type: object
      properties:
        Message:
          type: string
          description: "The exception message."
        ExceptionMessage:
          type: string
        Type:
          type: string
          description: "The exception type.""
        InnerError:
            $ref: '#/components/schemas/ServiceError'
             description: "If there's an inner exception, the InnerException.

    Property:
      type: object
      properties:
        Name:
          type: string
          description: Name of the property.

Ему не нравится строка «описание: «Если есть внутреннее исключение, InnerException», и если я его уберу, ему не нравится строка «Свойство:». Я пробовал много вещей, и ничего не работает. Что я не понимаю?


openapi swagger swagger-editor
person David Thielen    schedule 09.05.2020    source источник
comment
Ему не нравится InnerError.description, потому что в нем нет завершающей кавычки. И, как сказал Мартин, в конце Type.descritption есть дополнительная цитата. Вам нужно исправить кавычки.   -  person Helen    schedule 11.05.2020

Ответы (1)


arrow_upward
2
arrow_downward

  • description не допускается в $ref. См. этот ответ.
  • Перед InnnerError два '"'. Не уверен, что это просто ошибка копирования и вставки.
person Martin Hauner    schedule 10.05.2020
comment
Если описание не разрешено, как мне получить комментарий для этого свойства в сгенерированном коде? Спасибо - person David Thielen; 10.05.2020
comment
Сам ServiceError может иметь description. stackoverflow.com/a/41752575/1262371 показывает обходной путь с использованием allOf. - person Martin Hauner; 10.05.2020