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

The official website's command to try is not even working in the first place #3522

Open
hskang9 opened this issue Dec 19, 2024 · 5 comments
Open

Comments

@hskang9
Copy link

hskang9 commented Dec 19, 2024

Describe the bug

I used the example from the website to generate api documentation, and it does not work

To Reproduce

Steps to reproduce the behavior:

  1. Copy command in asyncapi.com
  2. Run on terminal
  3. It does not work and show that the library is deprecated.

Expected behavior

It should generate something in example

Copy link

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.

maskedwolf4 referenced this issue in maskedwolf4/spec Dec 27, 2024
…sole. It was solved by adding install.sh which is a script to hide the deprecated output and modified validate-examples.yml by giving cmd to run install.sh this solve the issue
@derberg derberg transferred this issue from asyncapi/spec Dec 28, 2024
Copy link

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 Dec 28, 2024

issue is related to new releases of generator and html-template, and since commands from https://www.asyncapi.com/tools/generator use always latest releases, then they do not work anymore

fix should be to make sure specific html template version is used: @asyncapi/[email protected] and add --use-new-generator flag.

asyncapi generate fromTemplate https://bit.ly/asyncapi @asyncapi/[email protected] -o example --use-new-generator

of course it needs to be checked first, then updated on website

also, docker command should be updated probably

@SahilDahekar
Copy link
Contributor

@derberg so the fix should be to just update the commands on website ?

Copy link
Member

derberg commented Jan 2, 2025

@SahilDahekar but of course they have to be checked manually on local, just to be 100% sure these is the right fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants