Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"path-only" for sideNaviStyle option to be validated correctly and documented. #2627

Open
muraaano opened this issue Dec 4, 2024 · 1 comment

Comments

@muraaano
Copy link

muraaano commented Dec 4, 2024

Describe the problem to be solved
Since #1805, sideNavStyle was added.
I tried to configure sideNavStyle to "path-only" then it was affected to the view but below warning were shown.

[1] redocly.yaml:8:19 at #/theme/openapi/sideNavStyle

`sideNavStyle` can be one of the following only: "summary-only", "path-first", "id-only".

 6 | hideHostname: true
 7 | pathInMiddlePanel: true
 8 | sideNavStyle: path-only
 9 |
10 | theme:

Warning was generated by the configuration spec rule.

Also, sideNavStyle is not documented.

Describe the solution you'd like

  1. On generation, sideNavStyle warning for "path-only" not to be shown.
  2. sideNavStyle to be documented
@muraaano muraaano changed the title The option for "sideNaviStyle" to be validated correctly and documented. "path-only" for sideNaviStyle option to be validated correctly and documented. Dec 4, 2024
@tatomyr
Copy link
Contributor

tatomyr commented Dec 30, 2024

@muraaano what Redocly CLI version you're using?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants