Skip to content

Commit 622951e

Browse files
mcruzdevmcruzdev
authored
Add ServerCodegenConfig updating docs (#1095)
1 parent 2479144 commit 622951e

File tree

6 files changed

+205
-4
lines changed

6 files changed

+205
-4
lines changed

‎docs/modules/ROOT/pages/includes/quarkus-openapi-generator-server.adoc‎

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,89 @@ h|[.header-title]##Configuration property##
77
h|Type
88
h|Default
99

10-
3+|No configuration properties found.
10+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-spec]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-spec[`quarkus.openapi.generator.spec`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.openapi.generator.spec+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
The OpenAPI specification filename.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_SPEC+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_SPEC+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|string
29+
|
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-input-base-dir]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-input-base-dir[`quarkus.openapi.generator.input-base-dir`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.openapi.generator.input-base-dir+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
The input base dir where the OpenAPI specification is.
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_INPUT_BASE_DIR+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_INPUT_BASE_DIR+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|string
50+
|`src/main/resources/openapi`
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-reactive]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-reactive[`quarkus.openapi.generator.reactive`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.openapi.generator.reactive+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Whether it must generate with reactive code.
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_REACTIVE+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_REACTIVE+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|boolean
71+
|`false`
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-base-package]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-base-package[`quarkus.openapi.generator.base-package`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.openapi.generator.base-package+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
The base package to be used to generated sources.
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_BASE_PACKAGE+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_BASE_PACKAGE+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`io.apicurio.api`
1193

1294
|===
1395

‎docs/modules/ROOT/pages/includes/quarkus-openapi-generator-server_quarkus.openapi.adoc‎

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,89 @@ h|[.header-title]##Configuration property##
77
h|Type
88
h|Default
99

10-
3+|No configuration properties found.
10+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-spec]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-spec[`quarkus.openapi.generator.spec`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.openapi.generator.spec+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
The OpenAPI specification filename.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_SPEC+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_SPEC+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|string
29+
|
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-input-base-dir]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-input-base-dir[`quarkus.openapi.generator.input-base-dir`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.openapi.generator.input-base-dir+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
The input base dir where the OpenAPI specification is.
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_INPUT_BASE_DIR+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_INPUT_BASE_DIR+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|string
50+
|`src/main/resources/openapi`
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-reactive]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-reactive[`quarkus.openapi.generator.reactive`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.openapi.generator.reactive+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Whether it must generate with reactive code.
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_REACTIVE+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_REACTIVE+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|boolean
71+
|`false`
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-openapi-generator-server_quarkus-openapi-generator-base-package]] [.property-path]##link:#quarkus-openapi-generator-server_quarkus-openapi-generator-base-package[`quarkus.openapi.generator.base-package`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.openapi.generator.base-package+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
The base package to be used to generated sources.
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR_BASE_PACKAGE+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR_BASE_PACKAGE+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`io.apicurio.api`
1193

1294
|===
1395

‎docs/modules/ROOT/pages/server.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ include::includes/want-to-contribute.adoc[]
1616
== Getting Started
1717

1818
include::./includes/server-getting-started.adoc[leveloffset=+1, opts=optional]
19+
20+
== Configuration Properties
21+
22+
include::./includes/quarkus-openapi-generator-server.adoc[opts=optional, leveloffset=+1]

‎server/deployment/src/main/java/io/quarkiverse/openapi/server/generator/deployment/CodegenConfig.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
@ConfigRoot(phase = ConfigPhase.BUILD_TIME)
88
@ConfigMapping(prefix = CodegenConfig.CODEGEN_TIME_CONFIG_PREFIX)
9-
public interface CodegenConfig {
9+
public interface CodegenConfig extends ServerCodegenConfig {
1010

1111
String CODEGEN_TIME_CONFIG_PREFIX = "quarkus.openapi.generator";
1212
String CODEGEN_BASE_PACKAGE = CODEGEN_TIME_CONFIG_PREFIX + ".base-package";

‎server/deployment/src/main/java/io/quarkiverse/openapi/server/generator/deployment/ServerCodegenConfig.java‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package io.quarkiverse.openapi.server.generator.deployment;
2+
3+
import java.util.Optional;
4+
5+
import io.smallrye.config.WithDefault;
6+
7+
public interface ServerCodegenConfig {
8+
9+
String DEFAULT_PACKAGE = "io.apicurio.api";
10+
11+
/**
12+
* The OpenAPI specification filename.
13+
*/
14+
Optional<String> spec();
15+
16+
/**
17+
* The input base dir where the OpenAPI specification is.
18+
*/
19+
@WithDefault("src/main/resources/openapi")
20+
Optional<String> inputBaseDir();
21+
22+
/**
23+
* Whether it must generate with reactive code.
24+
*/
25+
@WithDefault("false")
26+
boolean reactive();
27+
28+
/**
29+
* The base package to be used to generated sources.
30+
*/
31+
@WithDefault(DEFAULT_PACKAGE)
32+
Optional<String> basePackage();
33+
}

‎server/deployment/src/main/java/io/quarkiverse/openapi/server/generator/deployment/codegen/ApicurioCodegenWrapper.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import static io.quarkiverse.openapi.server.generator.deployment.CodegenConfig.getBasePackagePropertyName;
44
import static io.quarkiverse.openapi.server.generator.deployment.CodegenConfig.getCodegenReactive;
5+
import static io.quarkiverse.openapi.server.generator.deployment.ServerCodegenConfig.DEFAULT_PACKAGE;
56

67
import java.io.File;
78
import java.io.FileInputStream;
@@ -26,7 +27,6 @@
2627
public class ApicurioCodegenWrapper {
2728

2829
private static final Logger log = LoggerFactory.getLogger(ApicurioCodegenWrapper.class);
29-
private static final String DEFAULT_PACKAGE = "io.apicurio.api";
3030

3131
private final File outdir;
3232
private final JaxRsProjectSettings projectSettings;

0 commit comments

Comments
 (0)