loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)

Browse Source 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
This commit is contained in:
Jim Schubert
2020-01-19 20:19:11 -05:00
committed by GitHub
parent bbe88ba635
commit 644f720db8
143 changed files with 9131 additions and 9245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
docs/generators/php-laravel.md
View File

@@ -5,39 +5,39 @@ sidebar_label: php-laravel
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|sortModelPropertiesByRequiredFlag|Sort model properties 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|
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|srcBasePath|The directory to serve as source root.| |null|
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|modelPackage|package for generated models| |null|
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|srcBasePath|The directory to serve as source root.| |null|
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
## IMPORT MAPPING
| Type/Alias | Imports |
| ---------- | ------- |
|LocalDateTime|org.joda.time.*|
|Set|java.util.*|
|LocalTime|org.joda.time.*|
|HashMap|java.util.HashMap|
|Array|java.util.List|
|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|
|HashMap|java.util.HashMap|
|List|java.util.*|
|LocalDate|org.joda.time.*|
|LocalDateTime|org.joda.time.*|
|LocalTime|org.joda.time.*|
|Map|java.util.Map|
|Set|java.util.*|
|Timestamp|java.sql.Timestamp|
|URI|java.net.URI|
|UUID|java.util.UUID|
## INSTANTIATION TYPES
@@ -50,93 +50,93 @@ sidebar_label: php-laravel
## 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>void</li>
<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>DateTime</li>
<li>bool</li>
<li>string</li>
<li>double</li>
<li>boolean</li>
<li>byte</li>
<li>mixed</li>
<li>integer</li>
<li>double</li>
<li>float</li>
<li>int</li>
<li>DateTime</li>
<li>integer</li>
<li>mixed</li>
<li>number</li>
<li>boolean</li>
<li>object</li>
<li>string</li>
<li>void</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>die</li>
<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>__halt_compiler</li>
<li>_header_accept</li>
<li>_tempbody</li>
<li>abstract</li>
<li>and</li>
<li>array</li>
<li>as</li>
<li>break</li>
<li>callable</li>
<li>declare</li>
<li>isset</li>
<li>use</li>
<li>queryparams</li>
<li>echo</li>
<li>do</li>
<li>while</li>
<li>unset</li>
<li>empty</li>
<li>resourcepath</li>
<li>endwhile</li>
<li>protected</li>
<li>case</li>
<li>catch</li>
<li>class</li>
<li>clone</li>
<li>const</li>
<li>continue</li>
<li>declare</li>
<li>default</li>
<li>die</li>
<li>do</li>
<li>echo</li>
<li>else</li>
<li>elseif</li>
<li>function</li>
<li>empty</li>
<li>enddeclare</li>
<li>endfor</li>
<li>trait</li>
<li>catch</li>
<li>if</li>
<li>case</li>
<li>new</li>
<li>static</li>
<li>var</li>
<li>require</li>
<li>require_once</li>
<li>list</li>
<li>formparams</li>
<li>headerparams</li>
<li>_header_accept</li>
<li>include_once</li>
<li>exit</li>
<li>as</li>
<li>endforeach</li>
<li>endif</li>
<li>endswitch</li>
<li>endwhile</li>
<li>eval</li>
<li>exit</li>
<li>extends</li>
<li>final</li>
<li>try</li>
<li>httpbody</li>
<li>implements</li>
<li>private</li>
<li>const</li>
<li>for</li>
<li>global</li>
<li>interface</li>
<li>__halt_compiler</li>
<li>_tempbody</li>
<li>switch</li>
<li>foreach</li>
<li>default</li>
<li>formparams</li>
<li>function</li>
<li>global</li>
<li>goto</li>
<li>public</li>
<li>array</li>
<li>and</li>
<li>xor</li>
<li>class</li>
<li>headerparams</li>
<li>httpbody</li>
<li>if</li>
<li>implements</li>
<li>include</li>
<li>or</li>
<li>endswitch</li>
<li>break</li>
<li>enddeclare</li>
<li>abstract</li>
<li>include_once</li>
<li>instanceof</li>
<li>print</li>
<li>throw</li>
<li>insteadof</li>
<li>clone</li>
<li>interface</li>
<li>isset</li>
<li>list</li>
<li>namespace</li>
<li>endif</li>
<li>endforeach</li>
<li>new</li>
<li>or</li>
<li>print</li>
<li>private</li>
<li>protected</li>
<li>public</li>
<li>queryparams</li>
<li>require</li>
<li>require_once</li>
<li>resourcepath</li>
<li>return</li>
<li>static</li>
<li>switch</li>
<li>throw</li>
<li>trait</li>
<li>try</li>
<li>unset</li>
<li>use</li>
<li>var</li>
<li>while</li>
<li>xor</li>
</ul>