You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/customization.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ The above configuration will do the following:
56
56
* Compile a user-provided `my_custom_templates/api_interfaces.mustache` following our usual API template compilation logic. That is, one file will be created per API; APIs are generated defined according to tags in your spec documentation. The destination filename of `Interface.kt` will act as a suffix for the filename. So, a tag of `Equipment` will output a corresponding `EquipmentInterface.kt`.
57
57
* Because `api.mustache` is the same mustache filename as used in your target generator (`kotlin` in this example), we support the following:
58
58
- The destination filename provides a suffix for the generated output. APIs generate per tag in your specification. So, a tag of `Equipment` will output a corresponding `EquipmentImpl.kt`. This option will be used whether `api.mustache` targets a user customized template or a built-in template.
59
-
- The built-in template will be used if you haven't provided an customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
59
+
- The built-in template will be used if you haven't provided a customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
60
60
- Your `api.mustache` will be used if it exists in your custom template directory. For generators with library options, such as `jvm-okhttp3` in the kotlin generator, your file must exist in the same relative location as the embedded template. For kotlin using the `jvm-okhttp3` library option, this file would need to be located at `my_custom_templates/libraries/jvm-okhttp/api.mustache`. See [templating](./templating.md) for more details.
61
61
* Compile `my_custom_templates/other/check.mustache` with the supporting files bundle, and output to `scripts/check.sh` in your output directory. Note that we don't currently support setting file flags on output, so scripts such as these will either have to be sourced rather than executed, or have file flags set separately after generation (external to our tooling).
62
62
@@ -169,7 +169,7 @@ If you publish your artifact to a distant maven repository, do not forget to add
169
169
170
170
You may not want to generate *all* models in your project. Likewise, you may want just one or two apis to be written. If that's the case, you can use system properties or [global properties](./global-properties.md) to control the output.
171
171
172
-
The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
172
+
The default is to generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
173
173
174
174
```sh
175
175
# generate only models
@@ -397,7 +397,7 @@ or
397
397
398
398
## Schema Mapping
399
399
400
-
One can map the schema to someting else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
400
+
One can map the schema to something else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
Copy file name to clipboardExpand all lines: docs/generators/java-camel.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
38
38
|camelRestClientRequestValidation|enable validation of the client request to check whether the Content-Type and Accept headers from the client is supported by the Rest-DSL configuration||false|
39
39
|camelRestComponent|name of the Camel component to use as the REST consumer||servlet|
Copy file name to clipboardExpand all lines: docs/migration-from-swagger-codegen.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -173,10 +173,10 @@ The metadata folder (to store the `VERSION` file for example) is now called `.op
173
173
174
174
If you use a generator without specifying each parameter, you might see some differences in the generated code.
175
175
As example the default package name used in the generated code has changed.
176
-
You need to have a look at the specific value, depending of your target language, but often `Swagger` îs replaced by `OpenAPITools` and `io.swagger` is replaced by `org.openapitools`.
176
+
You need to have a look at the specific value, depending on your target language, but often `Swagger` îs replaced by `OpenAPITools` and `io.swagger` is replaced by `org.openapitools`.
177
177
Concretely if you did not specify anything when you are generating java code, a file `org/openapitools/api/PetApi.java` might be generated instead of `io/swagger/api/PetApi.java`.
178
178
179
-
If this is a problem for you, you need to explicitly set the the parameter value in order to match with the `swagger-codgen` default value (`apiPackage` == `io.swagger` in the previous example with the java generator).
179
+
If this is a problem for you, you need to explicitly set the parameter value in order to match with the `swagger-codegen` default value (`apiPackage` == `io.swagger` in the previous example with the java generator).
This is the default output location. This will be `generated-code/common-mark` on non-Windows machines and `generated-code\common-mark` on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.
Copy file name to clipboardExpand all lines: docs/roadmap.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Short term are focused on improving contributor and user productivity (part of t
37
37
> Feature set, well-defined API (code and templates), and extensibility improvements.
38
38
39
39
* API
40
-
** Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
40
+
** Typed representation of the model bound to our templates. As it is, everything is treated as an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
41
41
* Feature set (potential generators to add; not an exhaustive list)
Copy file name to clipboardExpand all lines: docs/roadmap.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Short term are focused on improving contributor and user productivity (part of t
27
27
* Automated release stability
28
28
* General
29
29
* OAS3.0 features support: anyOf, oneOf, callbacks, etc
30
-
* Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name). This would allow us to make prioritization decisions based on statistics.
30
+
* Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name. This would allow us to make prioritization decisions based on statistics.
31
31
* Code clean up
32
32
* centralize build scripts
33
33
* organize samples/bin scripts according to new generator names
@@ -43,7 +43,7 @@ Short term are focused on improving contributor and user productivity (part of t
43
43
> Feature set, well-defined API (code and templates), and extensibility improvements.
44
44
45
45
### API
46
-
* Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
46
+
* Typed representation of the model bound to our templates. As it is, everything is treated as an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
47
47
* Feature set (potential generators to add; not an exhaustive list)
Copy file name to clipboardExpand all lines: modules/openapi-generator-maven-plugin/examples/multi-module/sample-schema/src/main/resources/openapi.yaml
+1-1
Original file line number
Diff line number
Diff line change
@@ -335,7 +335,7 @@ paths:
335
335
- "store"
336
336
summary: "Find purchase order by ID"
337
337
description: "For valid response try integer IDs with value <= 5 or > 10. Other\
0 commit comments