docs: clarify the meaning of components #803
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
fmvilas
requested review from
derberg,
dalelane and
asyncapi-bot-eve
as code owners
fmvilas
commented
Jun 8, 2022
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>
|
Kudos, SonarCloud Quality Gate passed!
|
|
I don't see the need to rush on this PR so I prefer to wait for 3.0.0 to be honest. |
Closed
|
What can we do to move this forward, is it only reviews we need @fmvilas ? 🙂 |
dalelane
approved these changes
Jul 23, 2022
derberg
approved these changes
Jul 25, 2022
|
/rtm |
smoya
reviewed
Sep 22, 2022
| @@ -157,7 +159,7 @@ Field Name | Type | Description | |||
| <a name="A2SServers"></a>servers | [Servers Object](#serversObject) | Provides connection details of servers. | |||
| <a name="A2SDefaultContentType"></a>defaultContentType | [Default Content Type](#defaultContentTypeString) | Default content type to use when encoding/decoding a message's payload. | |||
| <a name="A2SChannels"></a>channels | [Channels Object](#channelsObject) | **Required** The available channels and messages for the API. | |||
| <a name="A2SComponents"></a>components | [Components Object](#componentsObject) | An element to hold various schemas for the specification. | |||
| <a name="A2SComponents"></a>components | [Components Object](#componentsObject) | An element to hold various reusable objects for the specification. Everything that is defined inside this object represents a resource that MAY or MAY NOT be used in the rest of the document and MAY or MAY NOT be used by the implemented [Application](#definitionsApplication). | |||
There was a problem hiding this comment.
I think makes sense to also add this clarification under Components Object description.
There was a problem hiding this comment.
Yup, agree. Would you mind opening the PR?
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.
This PR clarifies the meaning of the Components Object and, more importantly, the meaning of everything outside the Components Object.