Skip to content

Commit

Permalink
Clarify where to find the Operations and Navigation settings (bump-sh…
Browse files Browse the repository at this point in the history
…#261)

* Clarify where to find the Operations and Navigation settings

* Update src/_help/customization-options/operations-navigation.md

Co-authored-by: Paul B. <[email protected]>

---------

Co-authored-by: Christophe Dujarric <[email protected]>
Co-authored-by: Paul B. <[email protected]>
  • Loading branch information
3 people committed Jul 29, 2024
1 parent 801a1b0 commit ec22b2b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/_help/customization-options/operations-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ title: Operations and navigation
- TOC
{:toc}

Bump.sh offers several methods for sorting your API operations to provide a smooth and coherent reading structure, based on either the tags or operation names and URLs.
Bump.sh offers several methods for sorting your API operations to provide a smooth and coherent reading structure based on tags or operation names and URLs.

From the “Customize UI” tab in your documentation settings, you can select a custom operations & navigation grouping mode between either “Automatic”, “By Path” or “By Tag”.

## Automatic

Expand All @@ -17,7 +19,7 @@ If first-level field `tags` are present at the [root of your OpenAPI document ob

## Group operations by path

When `Group operations by path`` is chosen, Bump.sh deduces group names from related paths. The first part of the path is extracted to generate the group name, and every operation related to it will be grouped together.
When `Group operations by path` is chosen, Bump.sh deduces group names from related paths. The first part of the path is extracted to generate the group name, and every operation related to it will be grouped together.

![](/images/help/group-by-path.png)

Expand Down

0 comments on commit ec22b2b

Please sign in to comment.