Skip to content

W-17062055-asyncAPI-fa #625

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

Open
failup wants to merge 1 commit into
base: MS2026-05-ACB-1-19
Choose a base branch
from
+7 −2
Open

W-17062055-asyncAPI-fa #625

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
9 changes: 7 additions & 2 deletions modules/ROOT/pages/des-create-asyncapi-api-specs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ When the project is ready for editing, the API project opens the spec in the Edi
image::des-asyncapi-create.png[New AsyncAPI 2.6 (YAML) API project]
. Continue designing your API spec.
+
As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (Ctrl+Space) to display available options within the context.
As you enter elements, use xref:start-discover-ui.adoc#use-autocomplete[auto-complete] (Ctrl+Space) to display available options within the context, or use enhanced auto-completion by placing your cursor where you need suggestions and pressing Tab, Space, or starting to type.

[[import-spec]]
== Import an AsyncAPI Specification from MuleSoft VCS
Expand All @@ -96,7 +96,7 @@ MuleSoft: Import API Specification from MuleSoft VCS
If you receive an error that the import failed (*Importing project _a_project_name_ has failed*), check your target folder for a project with the same name. To address a duplicate naming issue before importing, you can import the design project to a different target folder or delete the project from your IDE (see xref:des-delete-api-projects.adoc[]).
. Edit or continue designing your spec, as needed.
+
As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (Ctrl+Space) to display available options within the context.
As you enter elements, use xref:start-discover-ui.adoc#use-autocomplete[auto-complete] (Ctrl+Space) to display available options within the context, or use enhanced auto-completion by placing your cursor where you need suggestions and pressing Tab, Space, or starting to type.
. Optionally, sync your changes by using MuleSoft VCS.
+
This feature is available only for API projects that you import from MuleSoft VCS. You can also store your work in another SCM. For SCM options, see xref:start-scm.adoc[].
Expand Down Expand Up @@ -135,6 +135,11 @@ For example, click *PUBLISH*:
+
image::des-asyncapi-api-console-detail.png["API Console with Publish details"]

[[supported-protocols-bindings]]
== Supported Protocols and Bindings for Implementation

While you can design AsyncAPI specs with any protocol and binding, only certain message brokers are supported for implementation through the APIkit for AsyncAPI module. For the list of supported message brokers, protocols, and configuration details, see xref:apikit::apikit-asyncapi-module-reference.adoc#supported-message-brokers[Supported Message Brokers].

[[example-asyncapi-api-spec]]
== Example AsyncAPI (YAML) API Specification

Expand Down