mirror of
https://github.com/jlengrand/openapi-generator.git
synced 2026-03-10 15:51:38 +00:00
[feat][docs][website] Initial docusaurus based site (#1770)
* Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
This commit is contained in:
Jim Schubert
committed by
William Cheng
William Cheng
parent
9cba9b6f88
commit
6fe9a52229
@@ -1,116 +1,44 @@
|
||||
|
||||
CONFIG OPTIONS for java-undertow-server
|
||||
---
|
||||
id: generator-opts-server-java-undertow-server
|
||||
title: Config Options for java-undertow-server
|
||||
sidebar_label: java-undertow-server
|
||||
---
|
||||
|
||||
sortParamsByRequiredFlag
|
||||
Sort method arguments to place required parameters before optional parameters. (Default: true)
|
||||
|
||||
ensureUniqueParams
|
||||
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
|
||||
|
||||
allowUnicodeIdentifiers
|
||||
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
|
||||
|
||||
prependFormOrBodyParameters
|
||||
Add form or body parameters to the beginning of the parameter list. (Default: false)
|
||||
|
||||
modelPackage
|
||||
package for generated models
|
||||
|
||||
apiPackage
|
||||
package for generated api classes
|
||||
|
||||
invokerPackage
|
||||
root package for generated code
|
||||
|
||||
groupId
|
||||
groupId in generated pom.xml
|
||||
|
||||
artifactId
|
||||
artifactId in generated pom.xml
|
||||
|
||||
artifactVersion
|
||||
artifact version in generated pom.xml
|
||||
|
||||
artifactUrl
|
||||
artifact URL in generated pom.xml
|
||||
|
||||
artifactDescription
|
||||
artifact description in generated pom.xml
|
||||
|
||||
scmConnection
|
||||
SCM connection in generated pom.xml
|
||||
|
||||
scmDeveloperConnection
|
||||
SCM developer connection in generated pom.xml
|
||||
|
||||
scmUrl
|
||||
SCM URL in generated pom.xml
|
||||
|
||||
developerName
|
||||
developer name in generated pom.xml
|
||||
|
||||
developerEmail
|
||||
developer email in generated pom.xml
|
||||
|
||||
developerOrganization
|
||||
developer organization in generated pom.xml
|
||||
|
||||
developerOrganizationUrl
|
||||
developer organization URL in generated pom.xml
|
||||
|
||||
licenseName
|
||||
The name of the license
|
||||
|
||||
licenseUrl
|
||||
The URL of the license
|
||||
|
||||
sourceFolder
|
||||
source folder for generated code
|
||||
|
||||
localVariablePrefix
|
||||
prefix for generated code members and local variables
|
||||
|
||||
serializableModel
|
||||
boolean - toggle "implements Serializable" for generated models (Default: false)
|
||||
|
||||
bigDecimalAsString
|
||||
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
|
||||
|
||||
fullJavaUtil
|
||||
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
|
||||
|
||||
hideGenerationTimestamp
|
||||
hides the timestamp when files were generated
|
||||
|
||||
withXml
|
||||
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false)
|
||||
|
||||
dateLibrary
|
||||
Option. Date library to use
|
||||
joda - Joda (for legacy app only)
|
||||
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
|
||||
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
|
||||
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
|
||||
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
|
||||
|
||||
java8
|
||||
Option. Use Java8 classes instead of third party equivalents
|
||||
true - Use Java 8 classes such as Base64
|
||||
false - Various third party libraries as needed
|
||||
|
||||
disableHtmlEscaping
|
||||
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
|
||||
|
||||
booleanGetterPrefix
|
||||
Set booleanGetterPrefix (default value 'get')
|
||||
|
||||
parentGroupId
|
||||
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
|
||||
|
||||
parentArtifactId
|
||||
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
|
||||
|
||||
parentVersion
|
||||
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
|
||||
|
||||
Back to the [generators list](README.md)
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|artifactId|artifactId in generated pom.xml| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml| |null|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |null|
|
||||
|artifactDescription|artifact description in generated pom.xml| |null|
|
||||
|scmConnection|SCM connection in generated pom.xml| |null|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null|
|
||||
|scmUrl|SCM URL in generated pom.xml| |null|
|
||||
|developerName|developer name in generated pom.xml| |null|
|
||||
|developerEmail|developer email in generated pom.xml| |null|
|
||||
|developerOrganization|developer organization in generated pom.xml| |null|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |null|
|
||||
|licenseName|The name of the license| |null|
|
||||
|licenseUrl|The URL of the license| |null|
|
||||
|sourceFolder|source folder for generated code| |null|
|
||||
|localVariablePrefix|prefix for generated code members and local variables| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|hides the timestamp when files were generated| |null|
|
||||
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|null|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|null|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|
||||
Reference in New Issue
Block a user