Skip to content

Unable to set x-displayName via preprocessors/decorators #1944

Closed
@mstade

Description

Describe the bug

It doesn't seem possible to set x-displayName fully via preprocessors/decorators. The title as rendered on the page is correct, however the title in the menu still uses what's inferred from the tag name.

To Reproduce
Steps to reproduce the behavior:

  1. Clone this repo: https://github.com/mstade/apidocs-starter
  2. Check out the repro branch:
    git checkout bug/x-displayName-not-settable-via-plugin
  3. Install dependencies:
    npm install
  4. Run the preview:
    npm run dev
  5. Notice how the tag x-displayName and description is overridden on the page, but the menu still displays the inferred tag name:
    Image

Expected behavior

I expect the menu to pick up the value of x-displayName as it was defined by the preprocessor/decorator.

OpenAPI description

https://github.com/mstade/apidocs-starter/blob/bug/x-displayName-not-settable-via-plugin/apis/%40v1_0/openapi.yaml
https://github.com/mstade/apidocs-starter/blob/bug/x-displayName-not-settable-via-plugin/apis/%40v1_1/openapi.yaml

Redocly Version(s)

❯ npm pkg get dependencies.@redocly/cli
"^1.30.0"

Node.js Version(s)

❯ node --version                       
v20.17.0

OS, environment

❯ system_profiler SPSoftwareDataType
Software:

    System Software Overview:

      System Version: macOS 14.6.1 (23G93)
      Kernel Version: Darwin 23.6.0

Activity

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

Metadata

Assignees

No one assigned

    Labels

    Type: BugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions