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

Building docs produces lots of warnings #2549

Closed
akrabat opened this issue Jun 9, 2024 · 4 comments
Closed

Building docs produces lots of warnings #2549

akrabat opened this issue Jun 9, 2024 · 4 comments

Comments

@akrabat
Copy link

akrabat commented Jun 9, 2024

Describe the bug

Building docs using the Docker image for redocly/cli produces more than a screenful of warning messages.

To Reproduce
Steps to reproduce the behaviour:

  1. Download the Museum example API: https://raw.githubusercontent.com/Redocly/museum-openapi-example/main/openapi.yaml and place in doc/
  2. Build the docs using the Docker container: docker run --rm -v $PWD/doc:/spec redocly/cli build-docs openapi.yaml
  3. See the output:

Screenshot 2024-06-09 at 15 29 01

Full output at https://gist.github.com/akrabat/5a75b89104a884c1128d4f251078628b

Expected behavior

Successfully building the docs should show no warnings related to the build environment and only warnings related to my OpenAPI spec (if any).

Redocly Version(s)

$ docker run --rm -v $PWD/doc:/spec redocly/cli --version
1.14.0

Node.js Version(s)

Whatever is in the Docker container

@akrabat
Copy link
Author

akrabat commented Jun 9, 2024

I've just tested with a local installation using npm i -g @redocly/cli@latest and I get the same thing.

redocly version: 1.14.0
node version: v18.19.1

@tatomyr
Copy link
Contributor

tatomyr commented Jun 10, 2024

Hi @akrabat! The warnings come from Redoc rather than from the CLI itself. Transferring the issue.

@tatomyr tatomyr transferred this issue from Redocly/redocly-cli Jun 10, 2024
@AlexVarchuk
Copy link
Collaborator

fixed via #2547

@tatomyr please upgrade redoc to v2.1.5 in @redocly/cli

@tatomyr
Copy link
Contributor

tatomyr commented Jun 10, 2024

Thanks @AlexVarchuk!

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

3 participants