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

File Location $ref Inconsistent Between validate and generate Commands #1057

Closed
baxterjo opened this issue Oct 24, 2023 · 3 comments
Closed
Labels
bug Something isn't working

Comments

@baxterjo
Copy link

baxterjo commented Oct 24, 2023

Describe the bug

Generator and validator do not have consistent behaviors for local file $refs when API doc is lower in the FS than where commands are being run from.

How to Reproduce

  1. Create an API doc that references another file below your current position in the FS e.g.: example_dir/example_api.yaml
  2. Create the file that is to be referenced and fill it with valid data.
  3. When running the validator, the reference must be relative to the location of the API file.
  4. When running the generator the reference must be relative to where the generator is run from
  • Work is for a private repository so I can't provide additional data

Expected behavior

Both asyncapi commands should have consistent results. I believe the json schema spec for $ref should be relative to the api document.

@baxterjo baxterjo added the bug Something isn't working label Oct 24, 2023
@github-actions
Copy link
Contributor

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.

@derberg
Copy link
Member

derberg commented Jan 17, 2024

hey there, please provide more details:

  • what validator you have in mind and you do you run it
  • how do you run the generator, please provide example

@derberg
Copy link
Member

derberg commented Mar 11, 2024

no more details provided, closing

if the issue is still there, please create a new issue with much more details, the best if these help us replicate the issue

@derberg derberg closed this as completed Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants