actions-marketplace-validations/Generator, Validator, Converter and others - all in one for your AsyncAPI docs
Use this action to generate docs or code from your AsyncAPI document. Use default templates or provide your custom ones.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Jan 22, 2025
- License
- Apache 2.0
Pinned Snippet
uses: actions-marketplace-validations/asyncapi_github-action-for-generator@a013514d846cc5e3918b8198ee97be0d418bfb58 # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| cli_version | Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option. | no | "" |
| command | Command to run. Available commands in action :- generate, validate, convert, optimize and custom. Default is generate. For custom command, provide the whole command as input. List of available commands can be found in https://www.asyncapi.com/docs/tools/cli/usage. | no | generate |
| filepath | Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml | no | asyncapi.yml |
| template | Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template. | no | @asyncapi/markdown-template@0.10.0 |
| language | Language of the generated code. This input is required if you want to generate models. List of available languages can be found in https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-models-language-file | no | "" |
| output | Directory where to put the generated files. Can be used only with generate or convert commands. Default is output. | no | output |
| parameters | The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p | no | "" |
| custom_command | Custom command to be run. This input is required if command is set to custom. | no | "" |
Outputs
no outputs