Output file generation issue: Merging of $refs for error response definitions not working as expected

[jcfausto]

$refs are not being rendered correctly when generating the output file. It looks like a bug.

Detailed description

Descriptions below are based on this example: https://github.com/jcfausto/speccy-ref-path-rendering-issue

Command used to output the file:

$ npx speccy resolve -v index.yaml -o output.yaml

Expected outcome

That every $ref will have its content rendered to the output.yaml file.

Details

├── README.md
├── index.yaml
├── output.yaml
├── shared
│   └── schemas
│       └── error.yaml
└── v1
    ├── books
    │   └── index.yaml
    └── pets
        └── index.yaml

I have a single definition for error messages in the shared/schemas/error.yaml file.

For the resources books and pets I'd like to reuse that when describing error responses as you can see in /v1/books/index.yaml and /v1/pets/index.yaml files.

When I render the output file, the first occurence of the $ref to the shared/schemas/error.yaml is merged correctly, but the following references don't.

They get merged, for all other reference toshared/schemas/error.yaml like this:

$ref: "#/paths/~1v1~1books/get/responses/401/content/application~1json/schema"

The base path #/paths/~1v1~1books, method get and status code 401 are all comming from the first $ref that was rendered correctly.

That creates outputs like this:

  /v1/pets:
    get:
      responses:
        "200":
          description: success
        "500":
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: "#/paths/~1v1~1books/get/responses/401/content/application~1j\
                  son/schema"

Where, the path is /v1/pets, but the $ref for the 500 status code is referencing the /v1/books path and the 401 status code when it should have merged the content of the referenced file instead.

Your environment

Node: 10.18.0
Speccy: 0.11.0

• Node Version: 10.18.0
• Operating system and version (e.g. Ubuntu 16.04, Windows 7): MacOS Catalina, 10.15.1
• Link to your project: https://github.com/jcfausto/speccy-ref-path-rendering-issue

[sashasklar]

Is there any update on this issue? I'm facing the same issue where imported schemas show up as paths

[jcfausto]

No progress so far. Won't be able to work on this issue any soon. If you're using Redoc as well, you might want to look at the bundle command. In our case, it was a good replacement.

[quintus-luis]

Same problem here....