Skip to content

[doc] full generator details #4941

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

Merged
merged 1 commit into from
Jan 9, 2020
Merged

[doc] full generator details #4941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion bin/utils/export_generator.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ fi

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

java -jar ${executable} config-help -g "${NAME}" --named-header --format markdown --markdown-header -o "docs/generators/${NAME}.md"
java -jar ${executable} config-help -g "${NAME}" --full-details --named-header --format markdown --markdown-header -o "docs/generators/${NAME}.md"
100 changes: 100 additions & 0 deletions docs/generators/ada-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,103 @@ sidebar_label: ada-server
|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|
|projectName|GNAT project name| |defaultProject|

## IMPORT MAPPING

| Type/Alias | Imports |
| ---------- | ------- |


## INSTANTIATION TYPES

| Type/Alias | Instantiated By |
| ---------- | --------------- |


## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Integer</li>
<li>boolean</li>
<li>Character</li>
<li>double</li>
<li>integer</li>
<li>Boolean</li>
<li>float</li>
<li>long</li>
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>exception</li>
<li>synchronized</li>
<li>constant</li>
<li>mod</li>
<li>select</li>
<li>declare</li>
<li>separate</li>
<li>use</li>
<li>do</li>
<li>elsif</li>
<li>body</li>
<li>type</li>
<li>while</li>
<li>when</li>
<li>aliased</li>
<li>protected</li>
<li>tagged</li>
<li>else</li>
<li>loop</li>
<li>function</li>
<li>record</li>
<li>raise</li>
<li>rem</li>
<li>if</li>
<li>case</li>
<li>others</li>
<li>all</li>
<li>new</li>
<li>package</li>
<li>in</li>
<li>is</li>
<li>then</li>
<li>pragma</li>
<li>accept</li>
<li>entry</li>
<li>exit</li>
<li>at</li>
<li>delay</li>
<li>task</li>
<li>null</li>
<li>abort</li>
<li>overriding</li>
<li>terminate</li>
<li>begin</li>
<li>some</li>
<li>private</li>
<li>access</li>
<li>for</li>
<li>range</li>
<li>interface</li>
<li>out</li>
<li>not</li>
<li>goto</li>
<li>array</li>
<li>subtype</li>
<li>and</li>
<li>of</li>
<li>end</li>
<li>xor</li>
<li>or</li>
<li>limited</li>
<li>abstract</li>
<li>procedure</li>
<li>reverse</li>
<li>generic</li>
<li>renames</li>
<li>requeue</li>
<li>with</li>
<li>abs</li>
<li>digits</li>
<li>until</li>
<li>return</li>
</ul>
100 changes: 100 additions & 0 deletions docs/generators/ada.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,103 @@ sidebar_label: ada
|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|
|projectName|GNAT project name| |defaultProject|

## IMPORT MAPPING

| Type/Alias | Imports |
| ---------- | ------- |


## INSTANTIATION TYPES

| Type/Alias | Instantiated By |
| ---------- | --------------- |


## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Integer</li>
<li>boolean</li>
<li>Character</li>
<li>double</li>
<li>integer</li>
<li>Boolean</li>
<li>float</li>
<li>long</li>
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>exception</li>
<li>synchronized</li>
<li>constant</li>
<li>mod</li>
<li>select</li>
<li>declare</li>
<li>separate</li>
<li>use</li>
<li>do</li>
<li>elsif</li>
<li>body</li>
<li>type</li>
<li>while</li>
<li>when</li>
<li>aliased</li>
<li>protected</li>
<li>tagged</li>
<li>else</li>
<li>loop</li>
<li>function</li>
<li>record</li>
<li>raise</li>
<li>rem</li>
<li>if</li>
<li>case</li>
<li>others</li>
<li>all</li>
<li>new</li>
<li>package</li>
<li>in</li>
<li>is</li>
<li>then</li>
<li>pragma</li>
<li>accept</li>
<li>entry</li>
<li>exit</li>
<li>at</li>
<li>delay</li>
<li>task</li>
<li>null</li>
<li>abort</li>
<li>overriding</li>
<li>terminate</li>
<li>begin</li>
<li>some</li>
<li>private</li>
<li>access</li>
<li>for</li>
<li>range</li>
<li>interface</li>
<li>out</li>
<li>not</li>
<li>goto</li>
<li>array</li>
<li>subtype</li>
<li>and</li>
<li>of</li>
<li>end</li>
<li>xor</li>
<li>or</li>
<li>limited</li>
<li>abstract</li>
<li>procedure</li>
<li>reverse</li>
<li>generic</li>
<li>renames</li>
<li>requeue</li>
<li>with</li>
<li>abs</li>
<li>digits</li>
<li>until</li>
<li>return</li>
</ul>
111 changes: 111 additions & 0 deletions docs/generators/android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,114 @@ sidebar_label: android
|androidBuildToolsVersion|buildToolsVersion version for use in the generated build.gradle| |null|
|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|
|library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release.</dd><dl>|null|

## IMPORT MAPPING

| Type/Alias | Imports |
| ---------- | ------- |
|LocalDateTime|org.joda.time.*|
|Set|java.util.*|
|LocalTime|org.joda.time.*|
|HashMap|java.util.HashMap|
|ArrayList|java.util.ArrayList|
|URI|java.net.URI|
|Timestamp|java.sql.Timestamp|
|LocalDate|org.joda.time.*|
|BigDecimal|java.math.BigDecimal|
|Date|java.util.Date|
|DateTime|org.joda.time.*|
|Array|java.util.List|
|List|java.util.*|
|UUID|java.util.UUID|
|File|java.io.File|
|Map|java.util.Map|


## INSTANTIATION TYPES

| Type/Alias | Instantiated By |
| ---------- | --------------- |
|array|ArrayList|
|map|HashMap|


## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Integer</li>
<li>byte[]</li>
<li>Float</li>
<li>boolean</li>
<li>Long</li>
<li>Object</li>
<li>String</li>
<li>Boolean</li>
<li>Double</li>
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>synchronized</li>
<li>basepath</li>
<li>do</li>
<li>float</li>
<li>while</li>
<li>localvarpath</li>
<li>protected</li>
<li>continue</li>
<li>else</li>
<li>localvarqueryparams</li>
<li>catch</li>
<li>if</li>
<li>case</li>
<li>new</li>
<li>package</li>
<li>static</li>
<li>void</li>
<li>double</li>
<li>byte</li>
<li>finally</li>
<li>this</li>
<li>strictfp</li>
<li>throws</li>
<li>enum</li>
<li>extends</li>
<li>null</li>
<li>transient</li>
<li>final</li>
<li>try</li>
<li>localvarbuilder</li>
<li>object</li>
<li>localvarcontenttypes</li>
<li>implements</li>
<li>private</li>
<li>import</li>
<li>const</li>
<li>for</li>
<li>interface</li>
<li>long</li>
<li>switch</li>
<li>default</li>
<li>goto</li>
<li>public</li>
<li>localvarheaderparams</li>
<li>native</li>
<li>localvarcontenttype</li>
<li>apiinvoker</li>
<li>assert</li>
<li>class</li>
<li>localvarformparams</li>
<li>break</li>
<li>localvarresponse</li>
<li>volatile</li>
<li>abstract</li>
<li>int</li>
<li>instanceof</li>
<li>super</li>
<li>boolean</li>
<li>throw</li>
<li>localvarpostbody</li>
<li>char</li>
<li>short</li>
<li>authnames</li>
<li>return</li>
</ul>
36 changes: 36 additions & 0 deletions docs/generators/apache2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,39 @@ sidebar_label: apache2
|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|
|userInfoPath|Path to the user and group files| |null|

## IMPORT MAPPING

| Type/Alias | Imports |
| ---------- | ------- |
|LocalDateTime|org.joda.time.*|
|Set|java.util.*|
|LocalTime|org.joda.time.*|
|HashMap|java.util.HashMap|
|ArrayList|java.util.ArrayList|
|URI|java.net.URI|
|Timestamp|java.sql.Timestamp|
|LocalDate|org.joda.time.*|
|BigDecimal|java.math.BigDecimal|
|Date|java.util.Date|
|DateTime|org.joda.time.*|
|Array|java.util.List|
|List|java.util.*|
|UUID|java.util.UUID|
|File|java.io.File|
|Map|java.util.Map|


## INSTANTIATION TYPES

| Type/Alias | Instantiated By |
| ---------- | --------------- |


## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
Loading