Fix: Fixed autogenerated description #189
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
ctasada
force-pushed
the
ctasada/fix-description
branch
from
81def66 to
7db212b
Compare
sam0r040
requested changes
Jun 2, 2023
...shamir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java
Outdated
Show resolved
Hide resolved
sam0r040
requested changes
Jun 2, 2023
|
@ctasada Is there anything anything else you like to see being included in the next release? |
Nothing urgent. If we can get another release done in 2-4 weeks I think I'm good 😉 |
added 2 commits
June 5, 2023 18:22
When defining an `@AsyncOperation` description like in
```
@AsyncOperation(
channelName = "channel-name",
description = "My channel description")
```
The generated AsyncAPI schema was always showing `Auto-generated description`
now properly shows the defined `description` value.
The Message description was not properly parsed and wrongly showed the Operation description. Until it's properly fixed, we decided to remove this misguiding description
ctasada
force-pushed
the
ctasada/fix-description
branch
from
7db212b to
cd138eb
Compare
The Message description was not properly parsed and wrongly showed the Operation description. Until it's properly fixed, we decided to remove this misguiding description
timonback
approved these changes
Jun 5, 2023
ctasada
pushed a commit
to ctasada/springwolf-core
that referenced
this pull request
Jun 6, 2023
While working at springwolf#189 we found out that the provided Message description was, in fact, the one associated to the Operation. As a result we decided to fully remove the description until we could fix it. This PR adds support for Message description. Any `Message` object, annotated with `@Schema` will use the annotation `description` value, as the Message description. The https://www.springwolf.dev/docs/configuration/documenting-schemas documentation is already stating this scenario, so I don't think we need further documentation updates.
ctasada
pushed a commit
to ctasada/springwolf-core
that referenced
this pull request
Jun 6, 2023
While working at springwolf#189 we found out that the provided Message description was, in fact, the one associated to the Operation. As a result we decided to fully remove the description until we could fix it. This PR adds support for Message description. Any `Message` object, annotated with `@Schema` will use the annotation `description` value, as the Message description. The https://www.springwolf.dev/docs/configuration/documenting-schemas documentation is already stating this scenario, so I don't think we need further documentation updates.
ctasada
pushed a commit
to ctasada/springwolf-core
that referenced
this pull request
Jun 7, 2023
While working at springwolf#189 we found out that the provided Message description was, in fact, the one associated to the Operation. As a result we decided to fully remove the description until we could fix it. This PR adds support for Message description. Any `Message` object, annotated with `@Schema` will use the annotation `description` value, as the Message description. The https://www.springwolf.dev/docs/configuration/documenting-schemas documentation is already stating this scenario, so I don't think we need further documentation updates.
timonback
pushed a commit
that referenced
this pull request
Jun 7, 2023
While working at #189 we found out that the provided Message description was, in fact, the one associated to the Operation. As a result we decided to fully remove the description until we could fix it. This PR adds support for Message description. Any `Message` object, annotated with `@Schema` will use the annotation `description` value, as the Message description.
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.
When defining an
@AsyncOperationdescription like inThe generated AsyncAPI schema was always showing
Auto-generated descriptionnow properly shows the defined
descriptionvalue.