Skip to content

redoc.yaml mostly ignored in VS Code? #80

@P-Lng

Description

@P-Lng

What happened?
Redocly OpenAPI preview in VS Code seems to (mostly) ignore redocly.yaml.
I'd be happy to correct any mistake on my side, any suggestions appreciated. Thanks!

Minimal reproducible setup

File structure

example_api.yaml:

openapi: 3.1.0
info:
  title: Example API
  version: 1.0.0
  x-logo:
    url: 'logo.png'
paths:
  /example:
    put:
      responses:
        '200':
          description: Successful update

redocly.yaml:

apis:
  example_xxx:
    root: example_api.yaml
theme:
  openapi:
    theme:
      colors:
        text:
          primary: "#0ed145"

logo.png: Any image.

Screenshots

VS Code screenshot

  1. ❌ The logo is not shown
  2. ❌ Text color is ignored
  3. ✅ The name (example_xxx) is used though (displayed above the spec). This is also updated whenever I save my file, so redocly.yaml is actually used.

Generating the spec using build-docs results in a fully working html file:
Image

Additional context

  • Extension version: 0.6.9
  • All my files are saved
  • redocly.yaml is in the top level workspace directory

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions