-
Notifications
You must be signed in to change notification settings - Fork 131
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
Unexpected theme/htmlTemplate config warnings in v1.15.0 #1589
Comments
Looks like it's related to this change #1495 that was introduced in v1.15.0 |
Hello, I came here to report the same issue just now. It also seems to impact generatedCodeSamples which I get in addition to those stated above. I am using a fairly standard redocly.yaml which is from the starter project example. Let me know if there's info I can add that may help. |
Hi guys! features.openapi:
htmlTemplate: redoc-web/index.html
theme:
spacing:
unit: 5 # CE # main spacing unit used in autocomputed theme values later
... Please let me know if you need any other assistance. |
@tatomyr no worries and thank you. Sorry, at the time I tried reproducing with openapi-starter but I didn't update the @redocly/cli version. I tried that again with it using the 1.15.0 version and the warnings are reproducible. I wasn't sure based on your message if the team was aware of that or not so just wanted to follow up. I updated the description with the reproduction steps I took. We'll remain on 1.14.0 for now. |
This configuration gives me a deprecation warning:
The linked document however says that this is what I should be migrating to, and the alternative config offered by the warning doesn't even work. I'm using v1.16.0 I'm brand new to redocly and at the moment I have no idea what I should or shouldn't be using for forward compatibility. |
@dutchgecko thanks for chiming in. Unless you're in our early adopters program, then I suggest you use a 1.14.x version of the CLI tool for now, which should validate correctly for our existing products. If that doesn't help, share your config and I'll take a look? |
@lornajane Thanks, I'll roll back for now. |
Describe the bug
Since updating @redocly/cli from 1.14.0 to 1.15.0, when running
npm test
which in turn runsredocly lint
, these 2 redocly.yaml warnings are reported unexpectedly:I don't know what is causing this since reviewing the openapi-starter, which I based the docs off years ago, it's a match. The keys are in the expected place and have valid values. Although if a value say in
theme
was invalid, I wouldn't expect that warning message.We encounter the same reported warnings both in CI (GitHub Actions) and locally.
For what it's worth, I had issues previously with the config file reporting warnings when we it was using the
features
key and that took awhile to be resolved.This change #1495 which was included v1.15.0 could be the cause.
This is my
redocly.yaml
file:To Reproduce
This is reproducible with the openapi-starter library which generates the same warnings and an additional one.
npm install
npm test
Expected behavior
The two warnings should not be reported since the config is valid and those two keys are in the correct location where they should be defined.
Logs
OpenAPI description
Redocly Version(s)
v1.15.0
Node.js
Version(s)v20.10.0
Additional context
The text was updated successfully, but these errors were encountered: