Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Main] Clarify vague points in documentation #620

Merged
merged 3 commits into from
Jan 9, 2024
Merged

[Main] Clarify vague points in documentation #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b81c462
Update getting-started.adoc
Pante Jan 9, 2024
8bb7eb2
Update logging.adoc
Pante Jan 9, 2024
32c9c00
Merge pull request #1 from Pante/patch-1
Pante Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/modules/ROOT/pages/includes/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,15 @@ To fine tune the configuration for each spec file, add the following entry to yo
quarkus.openapi-generator.codegen.spec.petstore_json.additional-model-type-annotations=@org.test.Foo;@org.test.Bar
----

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`.
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.
If a base package is not provided, it will default to `org.openapi.quarkus.<filename>`. For example, `org.openapi.quarkus.petstore_json`.

[source,properties]
----
quarkus.openapi-generator.codegen.spec.petstore_json.base-package=org.acme
----



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]).

Expand Down Expand Up @@ -125,4 +133,4 @@ public class PetResource {
}
----

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.
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.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/includes/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Since the most part of this extension work is in the `generate-code` execution p
mvn clean install -Dorg.slf4j.simpleLogger.log.org.openapitools=off
----

For more information, see the https://maven.apache.org/maven-logging.html[Maven Logging Configuration] guide.
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.
Loading