Skip to content

Commit 2966c0d

Browse files
authored
[Main] Clarify vague points in documentation (#620)
* Update getting-started.adoc * Update logging.adoc
1 parent d4dd63d commit 2966c0d

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

docs/modules/ROOT/pages/includes/getting-started.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,15 @@ To fine tune the configuration for each spec file, add the following entry to yo
5151
quarkus.openapi-generator.codegen.spec.petstore_json.additional-model-type-annotations=@org.test.Foo;@org.test.Bar
5252
----
5353

54-
If a base package name is not provided, it will be used the default `org.openapi.quarkus.<filename>`. For example, `org.openapi.quarkus.petstore_json`.
54+
If you want to change the base package in which the classes are generated, use the `quarkus.openapi-generator.codegen.spec.<filename>.base-package` property.
55+
If a base package is not provided, it will default to `org.openapi.quarkus.<filename>`. For example, `org.openapi.quarkus.petstore_json`.
56+
57+
[source,properties]
58+
----
59+
quarkus.openapi-generator.codegen.spec.petstore_json.base-package=org.acme
60+
----
61+
62+
5563

5664
Configuring `additional-model-type-annotations` will add all annotations to the generated model files (extra details can be found in https://openapi-generator.tech/docs/generators/java/#config-options[OpenApi Generator Doc]).
5765

@@ -125,4 +133,4 @@ public class PetResource {
125133
}
126134
----
127135

128-
See the https://github.com/quarkiverse/quarkus-openapi-generator/tree/main/integration-tests[integration-tests] module for more information of how to use this extension. Please be advised that the extension is on experimental, early development stage.
136+
See the https://github.com/quarkiverse/quarkus-openapi-generator/tree/main/integration-tests[integration-tests] module for more information of how to use this extension. Please be advised that the extension is on experimental, early development stage.

docs/modules/ROOT/pages/includes/logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Since the most part of this extension work is in the `generate-code` execution p
55
mvn clean install -Dorg.slf4j.simpleLogger.log.org.openapitools=off
66
----
77

8-
For more information, see the https://maven.apache.org/maven-logging.html[Maven Logging Configuration] guide.
8+
For more information, see the https://maven.apache.org/maven-logging.html[Maven Logging Configuration] and https://maven.apache.org/configure.html[Maven Configuration] guides.

0 commit comments

Comments
 (0)