From f7b5410c7899c151e9dd587fde665e00d16fa8b4 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Tue, 31 Oct 2023 10:11:17 +0100 Subject: [PATCH] Add notes about the server extension to the readme --- .github/workflows/build.yml | 8 ++++---- README.md | 6 +++--- client/pom.xml | 1 + 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ef60e759c..865798744 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -50,13 +50,13 @@ jobs: - name: Store PR id run: | - echo ${{ github.event.number }} > ./docs/target/generated-docs/pr-id.txt + echo ${{ github.event.number }} > ../client/docs/target/generated-docs/pr-id.txt - name: Publishing directory for PR preview uses: actions/upload-artifact@v3 with: name: site - path: ./docs/target/generated-docs + path: ../client/docs/target/generated-docs retention-days: 3 build_reactive: @@ -87,11 +87,11 @@ jobs: - name: Store PR id run: | - echo ${{ github.event.number }} > ./docs/target/generated-docs/pr-id.txt + echo ${{ github.event.number }} > ../client/docs/target/generated-docs/pr-id.txt - name: Publishing directory for PR preview uses: actions/upload-artifact@v3 with: name: site - path: ./docs/target/generated-docs + path: ../client/docs/target/generated-docs retention-days: 3 \ No newline at end of file diff --git a/README.md b/README.md index 50176f4a0..c2b3d611a 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ > **⚠️** Version 2.x.x of this extension (`main` branch) supports Quarkus 3, and version 1.x.x (`quarkus2` branch) supports Quarkus 2. -Quarkus' extension for generation of [Rest Clients](https://quarkus.io/guides/rest-client) based on OpenAPI specification files. +Quarkus' extensions for generation of [Rest Clients](https://quarkus.io/guides/rest-client) and server stubs generation based on the [Apicurio Codegen](https://github.com/Apicurio/apicurio-codegen) capabilities based on OpenAPI specification files. -This extension is based on the [OpenAPI Generator Tool](https://openapi-generator.tech/). Please consider donation to help them maintain the +This clien-side extension is based on the [OpenAPI Generator Tool](https://openapi-generator.tech/). Please consider donation to help them maintain the project: https://opencollective.com/openapi_generator/donate -This extension is for REST code generation for client side only. If you're looking for code generation for the server side, please take a look at the [Quarkus Apicurio Extension](https://github.com/Apicurio/apicurio-codegen/tree/main/quarkus-extension). +This repository holds two Quarkus extensions. The one located on the client folder is for REST code generation for client side only. The extension located in the server folder can be used for server stubs generation. **Want to contribute? Great!** We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... But first, read [this page](CONTRIBUTING.md). diff --git a/client/pom.xml b/client/pom.xml index 26645557e..3812a9547 100644 --- a/client/pom.xml +++ b/client/pom.xml @@ -17,5 +17,6 @@ deployment runtime docs + test-utils \ No newline at end of file