Добавление заголовков простого текста в API Blueprint

Question

У API Blueprint, как представляется, есть недокументированное правило, которое запрещает заголовки простого текста ниже или между группами ресурсов.У меня есть три заголовка простого текста над моей группой ресурсов, которые отображаются без проблем, но если я пытаюсь поместить заголовок простого текста под ним, я получаю следующие «семантические проблемы» в пасеке:

unexpected header block, expected a group, resource or an definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>

dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 12 spaces or 3 tabs

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

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

Answer 1

мне нужно, чтобы все мои простые текстовые заголовки были выше моей группы ресурсов?

Да .И даже в этом случае он может / должен потерпеть неудачу.

После открытия раздела группы ресурсов в API Blueprint могут следовать только следующие сведения:

• 0+ Группа ресурсов разделы
  • 0+ Ресурс разделы
• 0+ Структуры данных раздел

Спроектированное пространство для аннотаций Markdown в API Blueprint представляет собой блоки с отступом под документированным заголовком раздела (ресурс, группа, ...).Это называется описание раздела в документации.

Полная структура документа API Blueprint соответствует этой грамматике.