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.

Sign up for GitHub

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

W-17720815-Update-import-api-specification-exchange-doc-CP #595

Merged
merged 1 commit into from
Jan 31, 2025
Merged

W-17720815-Update-import-api-specification-exchange-doc-CP #595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/ROOT/pages/import-api-specification-exchange.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,20 @@ When scaffolding an AsyncAPI specification into a Mule project, Studio:
* Considers one spec at a time
* Treats the imported spec as a modification of an existing spec and evaluates it for rescaffolding
* Creates a new Mule project with a separate flow for each *publish* operation in the specification
* Generates an empty XML file with the name of your Mule project if the AsyncAPI spec doesn’t include a *publish* operation
* Generates an empty XML file with the name of your Mule project if the AsyncAPI spec doesn't include a *publish* operation
* Produces the configuration properties `file dev-properties.properties` file in the `src/main/resources` directory of your Mule project
* Makes the APIkit for AsyncAPI module available for use in the project
+
The module provides the following operations:

** *Publish* (`<apikit-asyncapi:publish/>`): AsyncAPI *subscribe* operations in the specification are available for configuration as AsyncAPI *Publish* operations.
** *Message Listener* (`<apikit-asyncapi:message-listener/>`): AsyncAPI *publish* operations in the specification are configurable *Message Listener* (not *Publish*) operations.
** *Subscribe* (`<apikit-asyncapi:publish/>`): AsyncAPI *subscribe* operations in the specification are available for configuration as AsyncAPI *publish* operations.
** *Message listener* (`<apikit-asyncapi:message-listener/>`): AsyncAPI *publish* operations in the specification are configurable *message listener* operations. The system publishes messages to a channel, and the Mule application listens for these messages.
+
The scaffolder transforms each *publish* operation into a *Message Listener* operation.
The scaffolder transforms each *publish* operation into a *message listener* operation allowing the Mule application to read from the specified channel and process the published messages.
+
If a *Message Listener* receives an invalid message, it’s sent to the dead-letter queue (you must set up one dead-letter queue).
If a *message listener* receives an invalid message, it's sent to the dead-letter queue (you must set up one dead-letter queue).

* Generates a `global-configs.xml` file with connection configurations for *Message Listener* and *Publish* operations in the AsyncAPI module and for any connectors the module depends on.
* Generates a `global-configs.xml` file with connection configurations for *message listener* and *publish* operations in the AsyncAPI module and for any connectors the module depends on.


Errors can occur during the scaffolding process:
Expand Down