0

It is necessary to add sub-items to the table of contents to make it easier to navigate the existing methods, but unfortunately, I cannot find the documentation where this would be described.

Roberto Hernandez
  • 8,231
  • 3
  • 14
  • 43
adg ghd
  • 33
  • 1
  • 6

1 Answers1

1

The TOC is constructed from the header blocks of your api blueprint document. It's limited to two levels of depth.

But within resource groups the nested headers are reserved for actions. The actions aren't listed on the TOC.

Here is an example of grouping resources: https://apiblueprint.org/documentation/examples/04-grouping-resources.html

Patrick Silva
  • 106
  • 2
  • 6
  • I cannot understand why when I use nesting, nested lists are not displayed in the left menu – adg ghd Aug 19 '20 at 13:00
  • For example, I have 3 levels of depth: # Group Messages ## My Message [/message] ### Retrieve a Message [GET] Level 3 is not displayed as sub-item 2 – adg ghd Aug 19 '20 at 13:03
  • It's like that by design. If all the Actions would be visible on the TOC it would get really cluttered in big documents. Just to be sure, in your example the Level 3 is an Action. – Patrick Silva Aug 19 '20 at 13:08
  • But why for example in this documentation API list have sub-item? https://apiary.docs.apiary.io/#reference/api-list – adg ghd Aug 19 '20 at 14:03
  • The sub-items you see on this document are equivalent of what you have in yours as `Some Route` and `Some Route 2`. They are Transactions and not Actions. The actions in this document are `Get User API List`, `Get Team API List`, that are also not present on the TOC. – Patrick Silva Aug 19 '20 at 16:27
  • Now I realized that sub-items can only be at the 1st nesting level. Thank you! – adg ghd Aug 20 '20 at 07:36