Skip to content

Commit 81da4e7

Browse files
authored
Merge pull request #87 from ZenWave360/main
updates documentation for main website compatibility
2 parents 20839e4 + 9e618ec commit 81da4e7

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

plugins/avro-schema-compiler/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Avro Schema Generator
1+
# (A Better) Avro Schema Generator
22

33
[![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)
44
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)
55

66
The Avro Schema Generator produces Java classes from Avro schemas using your chosen Avro Compiler version.
77
It supports Avro versions from 1.8.0 up to 1.12.0.
88

9-
### Why use this Avro Compiler Plugin?
9+
## Why use this Avro Generator Plugin?
1010

1111
- Sources Avro schemas from **local files**, **classpath resources**, or **authenticated remote HTTP URLs**.
1212
- Automatically **sorts schemas** to resolve dependencies for Avro versions prior to 1.12.0.
1313
- Ensures generated code is consistent and ready for integration in Java projects.
1414

1515
<!-- TOC -->
16-
* [Avro Schema Generator](#avro-schema-generator)
17-
* [Why use this Avro Compiler Plugin?](#why-use-this-avro-compiler-plugin)
16+
* [(A Better) Avro Schema Generator](#a-better-avro-schema-generator)
17+
* [Why use this Avro Generator Plugin?](#why-use-this-avro-generator-plugin)
1818
* [Usage](#usage)
1919
* [Using the ZenWave CLI](#using-the-zenwave-cli)
2020
* [Using the ZenWave Maven Plugin](#using-the-zenwave-maven-plugin)

plugins/openapi-controllers/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ requestBody:
9191
| `servicesPackage` | Package where your domain services/usecases interfaces are | String | `{{basePackage}}.core.inbound` | |
9292
| `inputDTOSuffix` | Should use same value configured in BackendApplicationDefaultPlugin. Whether to use an input DTO for entities used as command parameter. | String | | |
9393
| `includeControllerTests` | Include Controller Unit tests (using ServicesInMemoryConfig) | boolean | true | |
94-
| `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] | |
94+
| `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] | |
9595
| `formatter` | Code formatter implementation | Formatters | spring | google, palantir, spring, eclipse |
9696
| `skipFormatting` | Skip java sources output formatting | boolean | false | |
9797
| `haltOnFailFormatting` | Halt on formatting errors | boolean | true | |

plugins/zdl-to-asyncapi/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# ZDL To AsyncAPI Generator
2-
> 👉 ZenWave360 Helps You Create Software that's Easy to Understand
32

43
Generate AsyncAPI definition from ZDL Services and Events:
54

0 commit comments

Comments
 (0)