Skip to main content

Organize Your Portal Sidebar with Endpoint Groups

· 2 min read

You can now reference entire endpoint groups in toc.yml using endpoint-group, making it easier to organize large APIs and keep your documentation in sync with your API specification.

What’s New?

A new way to add endpoint groups to your toc.yml: use a generate entry with from: endpoint-group. All endpoints associated with that group in the API specification are included automatically.

toc:
- group: Ordering APIs
items:
- group: Item Details
items:
- generate: Item APIs
from: endpoint-group
endpoint-group: item
- generate: Item Inventory APIs
from: endpoint-group
endpoint-group: inventory
- group: Pricing
items:
- generate: Price Operations
from: endpoint-group
endpoint-group: price

This approach streamlines your configuration and keeps your sidebar organized as your API evolves.

Endpoint Grouping

Benefits

  • Reduce repetitive configuration in toc.yml
  • Keep documentation aligned automatically with the API specification
  • Simplify maintenance when endpoints are added or updated
  • Improve sidebar organization and navigation clarity

For detailed configuration steps, refer to this documentation.