Forum Discussion

mashapav's avatar
mashapav
New Member
2 months ago

API references grouping

Hi all! 

We have our backend references in OAS, and we'd like to build a side navigation that uses nested tags, similar to redocly's implementation of x-tag-groups . Does anyone have a clue how this can be implemented with Stoplight? 

Thanks!

 

  • Humashankar's avatar
    Humashankar
    2 months ago

    Hi mashapav 

    Although Stoplight doesn't currently support nested tags for grouping API references within the user interface of published documentation, try other options by utilizing tags for flat grouping, as Stoplight does allow tagging operations within your OpenAPI (OAS) specification.

    By assigning relevant tags to related endpoints, you can effectively group them under a single category, providing a similar organizational structure to nested tags.

    This workaround enables you to create a logical grouping of your API references, enhancing the navigation and discoverability of your documentation.

    Hope this helps - Happy to help further!!
    Thank you very much and have a great one!
    Warm regards

1 Reply

Sort By
  • Humashankar's avatar
    Humashankar
    Champion Level 2
    2 months ago

    Hi mashapav 

    Although Stoplight doesn't currently support nested tags for grouping API references within the user interface of published documentation, try other options by utilizing tags for flat grouping, as Stoplight does allow tagging operations within your OpenAPI (OAS) specification.

    By assigning relevant tags to related endpoints, you can effectively group them under a single category, providing a similar organizational structure to nested tags.

    This workaround enables you to create a logical grouping of your API references, enhancing the navigation and discoverability of your documentation.

    Hope this helps - Happy to help further!!
    Thank you very much and have a great one!
    Warm regards