CLI cannot generate fromTemplate when specification contains file path $refs

Laupetin commented 1 year ago

Describe the bug

When trying to generate with the html-template the process will fail when the specification file uses a $ref element that points to another file.

It will just show the following message and exit (The error message itself unfortunately is not really helpful):

Generator Error: Input is not a correct AsyncAPI document so it cannot be processed.

After adding a bit of logging it seems to me that it fails to resolve the path and cannot load the referenced file.

How to Reproduce

Running the following command will fail:

asyncapi generate fromTemplate ./index.yaml @asyncapi/html-template

when used with the following specification files:

# index.yaml
asyncapi: 2.5.0
info:
  title: Example
  version: 0.1.0
channels:
  user/signedup:
    $ref: subfolder/user-signedup.yaml

# subfolder/user-signedup.yaml
subscribe:
  message:
    description: An event describing that a user just signed up.
    payload:
      type: object
      additionalProperties: false
      properties:
        fullName:
          type: string
        email:
          type: string
          format: email
        age:
          type: integer
          minimum: 18

Expected behavior

The cli manages to generate output using the html-template and the given specification.

Running the generator directly instead of the cli does in fact produce the expected result:

ag index.yaml @asyncapi/html-template

github-actions[bot] commented 1 year ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

github-actions[bot] commented 8 months ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

asyncapi-bot commented 4 months ago

:tada: This issue has been resolved in version 2.1.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

asyncapi / cli