Search code examples
apiblueprintapiary.ioapiary

How can I create a nested table of contents in apiary?


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.


Solution

  • 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