updates documentation for main website compatibility

ivangsa · ivangsa · commit 85a5a0671ee2 · 2025-12-06T11:04:20.000+01:00
diff --git a/plugins/asyncapi-generator/README.md b/plugins/asyncapi-generator/README.md
@@ -1,10 +1,9 @@
 # AsyncAPI Generator for Java / Spring-Boot
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 [![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
 [![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
 
-![AsyncAPI and Spring Cloud Streams 3](../../docs/ZenWave360-AsyncAPI-SpringCloudStreams.excalidraw.svg)
+![ZenWave AsyncAPI Generator](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/refs/heads/main/docs/ZenWave360-AsyncAPI-SpringCloudStreams.excalidraw.svg)
 
 The ZenWave AsyncAPI Generator solves a long-standing issue in event-driven Java applications: 
 
@@ -254,8 +253,8 @@ sourceSets {
 | `role` | Project role: provider/client | AsyncapiRoleType | provider | provider, client  |
 | `templates` | Templates to use for code generation. | String | SpringCloudStream | SpringCloudStream, SpringKafka, FQ Class Name  |
 | `modelPackage` | Java Models package name | String |  |   |
-| `producerApiPackage` | Java API package name for outbound (producer) services. It can override apiPackage for producers. | String | {{apiPackage}} |   |
-| `consumerApiPackage` | Java API package name for inbound (consumer) services. It can override apiPackage for consumer. | String | {{apiPackage}} |   |
+| `producerApiPackage` | Java API package name for outbound (producer) services. It can override apiPackage for producers. | String | `{{apiPackage}}` |   |
+| `consumerApiPackage` | Java API package name for inbound (consumer) services. It can override apiPackage for consumer. | String | `{{apiPackage}}` |   |
 | `apiPackage` | Java API package, if `producerApiPackage` and `consumerApiPackage` are not set. | String |  |   |
 | `operationIds` | Operation ids to include in code generation. Generates code for ALL if left empty | List | [] |   |
 | `excludeOperationIds` | Operation ids to exclude in code generation. Skips code generation if is not included or is excluded. | List | [] |   |
diff --git a/plugins/asyncapi-jsonschema2pojo/README.md b/plugins/asyncapi-jsonschema2pojo/README.md
@@ -1,5 +1,4 @@
 # AsyncAPI and JsonSchema2Pojo (with maven plugin)
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 [![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
 [![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
@@ -43,7 +42,7 @@ jbang zw -p io.zenwave360.sdk.plugins.AsyncApiJsonSchema2PojoPlugin --help
 You can use ZenWave Maven Plugin to generate code as part of your build process:
 
 - Adding this generator jar as dependency to zenwave maven plugin.
-- Passing any configuration as <configOptions>.
+- Passing any configuration as `<configOptions>`.
 
 Use jsonschema2pojo prefix to pass any option to https://www.jsonschema2pojo.org/ underlying library.
 
diff --git a/plugins/asyncapi-spring-cloud-streams3/README.md b/plugins/asyncapi-spring-cloud-streams3/README.md
diff --git a/plugins/asyncapi-spring-cloud-streams3/src/main/java/io/zenwave360/sdk/plugins/SpringCloudStreams3Generator.java b/plugins/asyncapi-spring-cloud-streams3/src/main/java/io/zenwave360/sdk/plugins/SpringCloudStreams3Generator.java
@@ -66,7 +66,7 @@ public enum TransactionalOutboxType {
     @DocumentedOption(description = "Business/Service interface suffix")
     public String consumerServiceSuffix = "ConsumerService";
 
-    @DocumentedOption(description = "Spring-Boot binding suffix. It will be appended to the operation name kebab-cased. E.g. <operation-id>-in-0")
+    @DocumentedOption(description = "Spring-Boot binding suffix. It will be appended to the operation name kebab-cased. E.g. `<operation-id>-in-0`")
     public String bindingSuffix = "-0";
 
     @DocumentedOption(description = "AsyncAPI extension property name for runtime auto-configuration of headers.")
diff --git a/plugins/avro-schema-compiler/README.md b/plugins/avro-schema-compiler/README.md
@@ -1,5 +1,4 @@
 # Avro Schema Generator
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 [![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
 [![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
@@ -72,8 +71,8 @@ jbang zw -p io.zenwave360.sdk.plugins.AvroSchemaGeneratorPlugin \
         <!-- <authentication> -->
         <!--     <authentication><key>API_KEY</key><value>XXX</value></authentication> -->
         <!-- </authentication> -->
-        <addCompileSourceRoot>true</addCompileSourceRoot>!-- default is true -->
-        <addTestCompileSourceRoot>true</addTestCompileSourceRoot>!-- default is false -->
+        <addCompileSourceRoot>true</addCompileSourceRoot><!-- default is true -->
+        <addTestCompileSourceRoot>true</addTestCompileSourceRoot><!-- default is false -->
     </configuration>
 
     <executions>
diff --git a/plugins/backend-application-default/README.md b/plugins/backend-application-default/README.md
@@ -1,5 +1,4 @@
 # Backend Application Default Plugin
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 Generates a full backend application using the provided 'layout' property
 
diff --git a/plugins/customizations/kotlin-backend-application/README.md b/plugins/customizations/kotlin-backend-application/README.md
@@ -1,5 +1,4 @@
 # Backend Application Kotlin Templates
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 Generates a full backend application using the provided 'layout' property, but using Kotlin instead of Java.
 
diff --git a/plugins/java-to-asyncapi/README.md b/plugins/java-to-asyncapi/README.md
@@ -1,5 +1,4 @@
 # Java 2 AsyncAPI Reverse Engineering
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 If you are using Spring Modulith Events and want to generate an AsyncAPI definition from your event producer class, you can use this plugin.
 
diff --git a/plugins/java-to-jdl/README.md b/plugins/java-to-jdl/README.md
@@ -1,5 +1,4 @@
 # Java 2 JDL Reverse Engineering
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 If starting with legacy project, you can reverse engineer JDL from Java entity classes. JPA and MongoDB are supported.
 
diff --git a/plugins/openapi-controllers/README.md b/plugins/openapi-controllers/README.md
@@ -1,5 +1,4 @@
 # OpenAPI: REST Controllers Generator
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 Generates implementations based on JDL models and OpenAPI definitions SpringMVC generated OpenAPI interfaces.
 
@@ -82,17 +81,17 @@ requestBody:
 | `operationIds`              | OpenAPI operationIds to generate code for                                                                                                                                  | List             | []                                    |                                   |
 | `statusCodes`               | Status codes to generate code for                                                                                                                                          | List             | [200, 201, 202, 400]                  |                                   |
 | `openApiApiPackage`         | The package to used by OpenAPI-Generator for generated api objects/classes                                                                                                 | String           |                                       |                                   |
-| `openApiModelPackage`       | The package to used by OpenAPI-Generator for generated model objects/classes                                                                                               | String           | {{openApiApiPackage}}                 |                                   |
+| `openApiModelPackage`       | The package to used by OpenAPI-Generator for generated model objects/classes                                                                                               | String           | `{{openApiApiPackage}}`                 |                                   |
 | `openApiModelNamePrefix`    | Sets the prefix for model enums and classes used by OpenAPI-Generator                                                                                                      | String           |                                       |                                   |
 | `openApiModelNameSuffix`    | Sets the suffix for model enums and classes used by OpenAPI-Generator                                                                                                      | String           |                                       |                                   |
 | `basePackage`               | Applications base package                                                                                                                                                  | String           |                                       |                                   |
-| `controllersPackage`        | The package to generate REST Controllers                                                                                                                                   | String           | {{basePackage}}.adapters.web          |                                   |
-| `entitiesPackage`           | Package where your domain entities are                                                                                                                                     | String           | {{basePackage}}.core.domain           |                                   |
-| `inboundDtosPackage`        | Package where your inbound dtos are                                                                                                                                        | String           | {{basePackage}}.core.inbound.dtos     |                                   |
-| `servicesPackage`           | Package where your domain services/usecases interfaces are                                                                                                                 | String           | {{basePackage}}.core.inbound          |                                   |
+| `controllersPackage`        | The package to generate REST Controllers                                                                                                                                   | String           | `{{basePackage}}.adapters.web`          |                                   |
+| `entitiesPackage`           | Package where your domain entities are                                                                                                                                     | String           | `{{basePackage}}.core.domain`           |                                   |
+| `inboundDtosPackage`        | Package where your inbound dtos are                                                                                                                                        | String           | `{{basePackage}}.core.inbound.dtos`     |                                   |
+| `servicesPackage`           | Package where your domain services/usecases interfaces are                                                                                                                 | String           | `{{basePackage}}.core.inbound`          |                                   |
 | `inputDTOSuffix`            | Should use same value configured in BackendApplicationDefaultPlugin. Whether to use an input DTO for entities used as command parameter.                                   | String           |                                       |                                   |
 | `includeControllerTests`    | Include Controller Unit tests (using ServicesInMemoryConfig)                                                                                                               | boolean          | true                                  |                                   |
-| `paginatedDtoItemsJsonPath` | JSONPath list to search for response DTO schemas for list or paginated results. User '$.items' for lists or '$.properties.<content property>.items' for paginated results. | List             | [$.items, $.properties.content.items] |                                   |
+| `paginatedDtoItemsJsonPath` | JSONPath list to search for response DTO schemas for list or paginated results. User '$.items' for lists or '`$.properties.<content property>.items`' for paginated results. | List             | [$.items, $.properties.content.items] |                                   |
 | `formatter`                 | Code formatter implementation                                                                                                                                              | Formatters       | spring                                | google, palantir, spring, eclipse |
 | `skipFormatting`            | Skip java sources output formatting                                                                                                                                        | boolean          | false                                 |                                   |
 | `haltOnFailFormatting`      | Halt on formatting errors                                                                                                                                                  | boolean          | true                                  |                                   |
diff --git a/plugins/openapi-controllers/src/main/java/io/zenwave360/sdk/plugins/OpenAPIControllersGenerator.java b/plugins/openapi-controllers/src/main/java/io/zenwave360/sdk/plugins/OpenAPIControllersGenerator.java
@@ -40,7 +40,7 @@ public class OpenAPIControllersGenerator extends AbstractOpenAPIGenerator {
     @DocumentedOption(description = "Include Controller Unit tests (using ServicesInMemoryConfig)")
     public boolean includeControllerTests = true;
 
-    @DocumentedOption(description = "JSONPath list to search for response DTO schemas for list or paginated results. User '$.items' for lists or '$.properties.<content property>.items' for paginated results.")
+    @DocumentedOption(description = "JSONPath list to search for response DTO schemas for list or paginated results. User '$.items' for lists or '`$.properties.<content property>.items`' for paginated results.")
     public List<String> paginatedDtoItemsJsonPath = List.of("$.items", "$.properties.content.items");
 
     protected HandlebarsEngine handlebarsEngine = new HandlebarsEngine();
diff --git a/plugins/openapi-karate/README.md b/plugins/openapi-karate/README.md
@@ -1,5 +1,4 @@
 # OpenAPI to Karate Generator
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 Generates test for KarateDSL based on OpenAPI and Arazzo specifications.
 
@@ -28,7 +27,7 @@ jbang zw -p io.zenwave360.sdk.plugins.OpenAPIKaratePlugin \
 | `specFile`                     | API Specification File                                                       | URI         |                                                          |                                           |
 | `targetFolder`                 | Target folder to generate code to. If left empty, it will print to stdout.   | File        |                                                          |                                           |
 | `basePackage`                  | Applications base package                                                    | String      |                                                          |                                           |
-| `testsPackage`                 | Package name for generated tests                                             | String      | {{basePackage}}.adapters.web.tests                       |                                           |
+| `testsPackage`                 | Package name for generated tests                                             | String      | `{{basePackage}}.adapters.web.tests`                       |                                           |
 | `groupBy`                      | Generate test classes grouped by                                             | GroupByType | service                                                  | service, operation, partial, businessFlow |
 | `operationIds`                 | OpenAPI operationIds to generate code for                                    | List        | []                                                       |                                           |
 | `businessFlowTestName`         | Business Flow Test name                                                      | String      |                                                          |                                           |
diff --git a/plugins/openapi-spring-webtestclient/README.md b/plugins/openapi-spring-webtestclient/README.md
@@ -1,5 +1,4 @@
 # Spring WebTestClient Generator
-> 👉 ZenWave360 Helps You Create Software Easy to Understand
 
 Generates test for SpringMVC or Spring WebFlux using WebTestClient based on OpenAPI specification.
 
@@ -33,7 +32,7 @@ jbang zw -p io.zenwave360.sdk.plugins.SpringWebTestClientPlugin \
 |--------------------------------|------------------------------------------------------------------------------|--------------------|----------------------------------------------------------|-------------------------------------------|
 | `specFile`                     | API Specification File                                                       | URI                |                                                          |                                           |
 | `targetFolder`                 | Target folder to generate code to. If left empty, it will print to stdout.   | File               |                                                          |                                           |
-| `testsPackage`                 | Package name for generated tests                                             | String             | {{basePackage}}.adapters.web.tests                       |                                           |
+| `testsPackage`                 | Package name for generated tests                                             | String             | `{{basePackage}}.adapters.web.tests`                       |                                           |
 | `groupBy`                      | Generate test classes grouped by                                             | GroupByType        | service                                                  | service, operation, partial, businessFlow |
 | `testSuffix`                   | Class name suffix for generated test classes                                 | String             | IT                                                       |                                           |
 | `operationIds`                 | OpenAPI operationIds to generate code for                                    | List               | []                                                       |                                           |
@@ -43,7 +42,7 @@ jbang zw -p io.zenwave360.sdk.plugins.SpringWebTestClientPlugin \
 | `transactionalAnnotationClass` | @Transactional annotation class name                                         | String             | org.springframework.transaction.annotation.Transactional |                                           |
 | `basePackage`                  | Applications base package                                                    | String             |                                                          |                                           |
 | `openApiApiPackage`            | The package to used by OpenAPI-Generator for generated api objects/classes   | String             |                                                          |                                           |
-| `openApiModelPackage`          | The package to used by OpenAPI-Generator for generated model objects/classes | String             | {{openApiApiPackage}}                                    |                                           |
+| `openApiModelPackage`          | The package to used by OpenAPI-Generator for generated model objects/classes | String             | `{{openApiApiPackage}}`                                    |                                           |
 | `openApiModelNamePrefix`       | Sets the prefix for model enums and classes used by OpenAPI-Generator        | String             |                                                          |                                           |
 | `openApiModelNameSuffix`       | Sets the suffix for model enums and classes used by OpenAPI-Generator        | String             |                                                          |                                           |
 | `statusCodes`                  | Status codes to generate code for                                            | List               | [200, 201, 202, 400]                                     |                                           |
diff --git a/plugins/zdl-to-asyncapi/README.md b/plugins/zdl-to-asyncapi/README.md
diff --git a/plugins/zdl-to-markdown/README.md b/plugins/zdl-to-markdown/README.md
diff --git a/plugins/zdl-to-openapi/README.md b/plugins/zdl-to-openapi/README.md
diff --git a/plugins/zenwave-mcp-server/README.md b/plugins/zenwave-mcp-server/README.md
diff --git a/zenwave-sdk-maven-plugin/README.md b/zenwave-sdk-maven-plugin/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`# Backend Application Default Plugin`
`2`		`-> 👉 ZenWave360 Helps You Create Software Easy to Understand`
`3`	`2`
`4`	`3`	`Generates a full backend application using the provided 'layout' property`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`# Backend Application Kotlin Templates`
`2`		`-> 👉 ZenWave360 Helps You Create Software Easy to Understand`
`3`	`2`
`4`	`3`	`Generates a full backend application using the provided 'layout' property, but using Kotlin instead of Java.`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`# Java 2 AsyncAPI Reverse Engineering`
`2`		`-> 👉 ZenWave360 Helps You Create Software Easy to Understand`
`3`	`2`
`4`	`3`	`If you are using Spring Modulith Events and want to generate an AsyncAPI definition from your event producer class, you can use this plugin.`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`# Java 2 JDL Reverse Engineering`
`2`		`-> 👉 ZenWave360 Helps You Create Software Easy to Understand`
`3`	`2`
`4`	`3`	`If starting with legacy project, you can reverse engineer JDL from Java entity classes. JPA and MongoDB are supported.`
`5`	`4`