Многострочные литералы в Редакторе swagger?

Я пытаюсь получить многострочный литерал в Редакторе Swagger (удивительный инструмент, кстати!).

  post:
    summary: Translate one or more identifiers
    description: |
Translate one or more identifiers for one entity into the
identifiers of another entity. Translate one or more
identifiers for one entity into the identifiers of another entity.

    consumes:
    - application/json

Я пробовал это с | и >, с разными окончаниями (увеличение отступа против пустой строки) и всеми способами, которые я могу придумать, но он всегда дает ту же ошибку:

YAML Syntax Error
Can not read a block mapping entry; a multiline key may not be an implicit  
key at line 24, column 15: consumes: ^

Я вижу ошибки для JS-YAML, которые указывают, что проблема-это новая строка в стиле Windows в конце, которую я знаю, что HTML textareas может создать. Это первый раз, когда я действительно использую YAML, так что это просто я делаю что-то не так, или ошибка в Редакторе Swagger?

8
indentation swagger swagger-editor yaml

2 ответов

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

/{user-id}:
get:
  summary: Facebook User
  description: |
    Displays all information about a Facebook user, depending on access privileges.  Displays all information about a Facebook user, depending on access privileges.
  parameters:
    - name: user-id
      in: path
      description: The Facebook user ID
      required: true
      type: string

в моем фактическом коде описание состоит из трех строк.

22

хотел добавить подход JSON. Я использую чистый JSON в Редакторе Swagger, чтобы избежать проблем с двойным синтаксисом (обучение, отладка, синтаксический анализ для веб-документации, etc.).

"get": {
    "description": "Hi\n\nThere",

по какой-то причине двойной символ новой строки \n казалось необходимым, по крайней мере, для отображения новой строки в Редакторе Swagger. Однако, когда я экспортировал официальный Uber API YAML демо как JSON (File - > Download as JSON), полученный JSON только имел одиночные символы новой строки, где были продемонстрированы многострочные литералы. Странный.

2