Merge pull request #41 from ctasada/ctasada/issue-38

feat: Added @asyncmessage documentation

Author: sam0r040

docs/configuration/documenting-schemas.md …cs/configuration/documenting-messages.mddocs/configuration/documenting-schemas.md renamed to docs/configuration/documenting-messages.md docs/configuration/documenting-schemas.md renamed to docs/configuration/documenting-messages.md

@@ -8,9 +8,34 @@ import CodeBlock from '@theme/CodeBlock';
 import CodeSchemaGroovy from '!!raw-loader!./snippets/_schema_groovy.md';
 import CodeSchemaMaven from '!!raw-loader!./snippets/_schema_maven.md';
 
-# Schemas
+# Messages
 
-Under the hood springwolf relies on swagger-core `ModelConverters`.
+Springwolf provides different ways to document the messages. The `message` is part of the AsyncApi `operationObject`
+
+> A definition of the message that will be published or received by this operation
+
+A message can be defined as part of the `@AsyncOperation` annotation, using `message = @AsyncMessage()` field.
+
+For example:
+```java
+@AsyncPublisher(operation = @AsyncOperation(
+        channelName = "example-producer-topic",
+        description = "Optional. Customer uploaded an example payload",
+        message = @AsyncMessage(
+                messageId = "my-unique-id",
+                name = "ExamplePayloadDto",
+                schemaFormat = "application/schema+json;version=draft-07",
+                description = "Example payload model for sending messages"
+        )
+))
+public void sendMessage(ExamplePayloadDto msg) {
+    // send
+}
+```
+
+## Schema
+
+Under the hood springwolf relies on swagger-core `ModelConverters` to define the message schema.
 
 By default, the type and example values for the properties are guessed.
 The default Jackson `ModelResolver` supports schema definitions via `@Schema` to overwrite the property definitions.
@@ -50,6 +75,10 @@ public class ExamplePayloadDto {
 }
 ```
 
+:::note
+The `@AsyncMessage.description` field will always override the `@Schema` description if provided
+:::
+
 For a full example, take a look at [ExamplePayloadDto.java in springwolf-amqp-example](https://github.com/springwolf/springwolf-core/blob/master/springwolf-examples/springwolf-amqp-example/src/main/java/io/github/stavshamir/springwolf/example/amqp/dtos/ExamplePayloadDto.java)
 
 ## Custom ModelConverters