From dfdb7689bb7c53a8755a9ea030af54feede567f1 Mon Sep 17 00:00:00 2001 From: Alejandra Quetzalli Date: Tue, 19 Dec 2023 04:32:57 -0800 Subject: [PATCH] docs: update asyncapi document definition (#1003) Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> --- spec/asyncapi.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/spec/asyncapi.md b/spec/asyncapi.md index 15d51f22..e1eb81f3 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -14,10 +14,9 @@ The AsyncAPI Specification is licensed under [The Apache License, Version 2.0](h The AsyncAPI Specification is a project used to describe message-driven APIs in a machine-readable format. It’s protocol-agnostic, so you can use it for APIs that work over any protocol (e.g., AMQP, MQTT, WebSockets, Kafka, STOMP, HTTP, Mercure, etc). -The AsyncAPI Specification defines a set of files required to describe the API of an [application](#definitionsApplication). -These files can be used to create utilities, such as documentation, code, integration, or testing tools. +The AsyncAPI Specification defines a set of fields that can be used in an AsyncAPI document to describe an [application](#definitionsApplication)'s API. The document may reference other files for additional details or shared fields, but it is typically a single, primary document that encapsulates the API description. -The file(s) SHOULD describe the operations an [application](#definitionsApplication) performs. For instance, consider the following AsyncAPI definition snippet: +The AsyncAPI document SHOULD describe the operations an [application](#definitionsApplication) performs. For instance, consider the following AsyncAPI definition snippet: ```yaml channels: