From 78c6f2d12c51380de1b105c5a2839cabacca6987 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Tue, 14 Jan 2025 09:03:56 +0100 Subject: [PATCH] docs(generator): update latest generator documentation (#3573) --- markdown/docs/tools/generator/api.md | 6 +++--- markdown/docs/tools/generator/installation-guide.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/markdown/docs/tools/generator/api.md b/markdown/docs/tools/generator/api.md index 42d7309e5fa9..3dd56e79e924 100644 --- a/markdown/docs/tools/generator/api.md +++ b/markdown/docs/tools/generator/api.md @@ -39,9 +39,9 @@ Reference API documentation for AsyncAPI Generator library. * [.executeAfterHook()](#Generator+executeAfterHook) ⇒ `Promise.` * [.parseInput()](#Generator+parseInput) * [.configureTemplate()](#Generator+configureTemplate) - * ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise`~~ - * [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise` - * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise` + * ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~ + * [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>` + * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>` * [.installTemplate([force])](#Generator+installTemplate) * _static_ * [.getTemplateFile(templateName, filePath, [templatesDir])](#Generator.getTemplateFile) ⇒ `Promise` diff --git a/markdown/docs/tools/generator/installation-guide.md b/markdown/docs/tools/generator/installation-guide.md index 958d1c5a92dc..302be0497518 100644 --- a/markdown/docs/tools/generator/installation-guide.md +++ b/markdown/docs/tools/generator/installation-guide.md @@ -73,7 +73,7 @@ To uninstall the generator, use the following command: npm uninstall @asyncapi/cli -g ``` -> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https://github.com/marketplace/actions/generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs). +> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https://github.com/marketplace/actions/generator-for-asyncapi-documents). ## Generator library in Node.js apps Use the generator library in your Node.js projects by installing it via the following command: `npm install @asyncapi/generator`.