Skip to content

W-17428955-import-raml-asyncAPI-fa #249

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
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

W-17428955-import-raml-asyncAPI-fa #249

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
14 changes: 14 additions & 0 deletions modules/ROOT/pages/design-async-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,20 @@ channels:

NOTE: For AVRO schema documents, `.avsc` is the default extension, but `.json` files are also supported.

== Referencing RAML Fragments

AsyncAPI supports referencing external RAML content using the `$ref` mechanism, enabling the reuse of RAML data types and fragments stored in YAML or JSON files.

WARNING: `$ref` can only be used at the root of the payload definition. Nested `$ref` usage within RAML content is not valid.

Example:
[source,yaml]
----
schemaFormat: application/raml+yaml;version=1.0
payload:
$ref: "./types.raml#test"
----

== Example AsyncAPI 2.0 Specification

This example is a typical event-driven process that is documented for easy reuse. It has a service with two channels, one that books the trade and another that gets the result of the booking asynchronously.
Expand Down