docs: update asyncapi document definition #1003
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
quetzalliwrites
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
derberg
reviewed
Dec 12, 2023
quetzalliwrites
commented
Dec 12, 2023
|
smoya
approved these changes
Dec 13, 2023
@smoya well thank youuuuu 😎 |
derberg
approved these changes
Dec 19, 2023
|
/rtm |
|
@all-contributors please add @alequetzalli for content,doc,example,ideas,review |
|
I've put up a pull request to add @alequetzalli! 🎉 |
|
@all-contributors please add @alequetzalli for content,doc,example,ideas,review |
|
I've put up a pull request to add @alequetzalli! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original spec text seems to inaccurately suggest that multiple AsyncAPI documents are required for each application, whereas the correct statement would be that a single AsyncAPI document, potentially referencing other files, is typically used to describe an application's API.
Perhaps it is more accurate to say that the AsyncAPI Specification defines a set of fields that can be used in one or more AsyncAPI documents to describe an application's API. A single AsyncAPI document can reference other files, but it doesn't mean that multiple AsyncAPI documents are required for a single application.
While the AsyncAPI document is the primary file describing the API, it can include references to other files that contain additional details or shared fields. This doesn't equate to requiring multiple AsyncAPI documents for a single application.
related to https://github.com/asyncapi/website/pull/1868/files#r1424279213