mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-08 05:06:09 +00:00
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
* [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
GitHub
@@ -5,27 +5,27 @@ sidebar_label: csharp-netcore
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dl>|netstandard2.0|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true|
|
||||
|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dl>|netstandard2.0|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|validatable|Generates self-validatable models.| |true|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@@ -44,133 +44,133 @@ sidebar_label: csharp-netcore
|
||||
|
||||
## 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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</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>struct</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>ushort</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>ref</li>
|
||||
<li>protected</li>
|
||||
<li>readonly</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>checked</li>
|
||||
<li>lock</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>Client</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>sizeof</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>unchecked</li>
|
||||
<li>is</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>object</li>
|
||||
<li>implicit</li>
|
||||
<li>internal</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>interface</li>
|
||||
<li>unsafe</li>
|
||||
<li>long</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>delegate</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>ulong</li>
|
||||
<li>goto</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>stackalloc</li>
|
||||
<li>parameter</li>
|
||||
<li>client</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>volatile</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>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>sbyte</li>
|
||||
<li>short</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>return</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
Reference in New Issue
Block a user