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

[C#/.NET] remove duplicate CLI option (#11925)

Browse Source
This commit is contained in:
Oleh Kurpiak 2022-03-21 06:50:19 +02:00 committed by GitHub
parent f4700487f8
commit 8acc5023a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/generators/csharp-netcore-functions.md
View File

@ -1,53 +1,51 @@
--- ---
title: Documentation for the csharp-netcore-functions Generator title: Documentation for the csharp-netcore-functions Generator
--- ---
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
=======
## METADATA ## METADATA
| Property | Value | Notes | | Property | Value | Notes |
| -------- | ----- | ----- | | -------- | ----- | ----- |
| generator name | csharp-netcore-functions | pass this to the generate command after -g | | generator name | csharp-netcore-functions | pass this to the generate command after -g |
| generator stability | BETA | | | generator stability | STABLE | |
| generator type | SERVER | | | generator type | SERVER | |
| generator language | C# | | | generator language | C# | |
| generator default templating engine | mustache | | | generator default templating engine | mustache | |
| helpTxt | Generates a csharp server. | | | helpTxt | Generates an ASP.NET Core Web API server. | |
## CONFIG OPTIONS ## CONFIG OPTIONS
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details. These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
| Option | Description | Values | Default | | Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- | | ------ | ----------- | ------ | ------- |
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| |azureFunctionsVersion|Azure functions version: v4, v3|<dl><dt>**v4**</dt><dd>Azure Functions v4</dd><dt>**v3**</dt><dd>Azure Functions v3</dd></dl>|v4|
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false| |buildTarget|Target to build an application or library|<dl><dt>**program**</dt><dd>Generate code for a standalone server</dd><dt>**library**</dt><dd>Generate code for a server abstract class library</dd></dl>|program|
|conditionalSerialization|Serialize only those properties which are initialized by user, accepted values are true or false, default value is false.| |false| |classModifier|Class Modifier for function classes: Empty string or abstract.| ||
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true| |enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| |enumValueSuffix|Suffix that will be appended to all enum values.| |Enum|
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I| |generateBody|Generates method body.| |true|
|library|HTTP library template (sub-template) to use|<dl><dt>**httpclient**</dt><dd>HttpClient (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. May subject to breaking changes without further notice.)</dd><dt>**restsharp**</dt><dd>RestSharp (https://github.com/restsharp/RestSharp)</dd></dl>|restsharp| |licenseName|The name of the license| |NoLicense|
|licenseId|The identifier of the license| |null| |licenseUrl|The URL of the license| |http://localhost|
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase| |modelClassModifier|Model Class Modifier can be nothing or partial| |partial|
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false| |netCoreVersion|.NET Core version: 6.0, 5.0, 3.1, 3.0|<dl><dt>**3.0**</dt><dd>.NET Core 3.0</dd><dt>**3.1**</dt><dd>.NET Core 3.1</dd><dt>**5.0**</dt><dd>.NET Core 5.0</dd><dt>**6.0**</dt><dd>.NET Core 6.0</dd></dl>|3.1|
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false| |newtonsoftVersion|Version for Newtonsoft.Json for .NET Core 3.0+| |3.0.0|
|nullableReferenceTypes|Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.| |false| |nullableReferenceTypes|Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.| |false|
|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true| |operationIsAsync|Set methods to async or sync (default).| |false|
|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false| |operationModifier|Operation Modifier can be virtual or abstract|<dl><dt>**virtual**</dt><dd>Keep method virtual</dd><dt>**abstract**</dt><dd>Make method abstract</dd></dl>|virtual|
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true| |operationResultTask|Set methods result to Task&lt;&gt;.| |false|
|optionalProjectFile|Generate {PackageName}.csproj.| |true| |packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|packageDescription|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |A library generated from a OpenAPI doc|
|packageGuid|The GUID that will be associated with the C# project| |null| |packageGuid|The GUID that will be associated with the C# project| |null|
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools| |packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|packageTags|Tags to identify the package| |null| |packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|packageVersion|C# package version.| |1.0.0| |packageVersion|C# package version.| |1.0.0|
|releaseNote|Release note, default to 'Minor update'.| |Minor update|
|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false| |returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|sourceFolder|source folder for generated code| |src| |sourceFolder|source folder for generated code| |src|
|targetFramework|The target .NET framework version. To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1`|<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>**netstandard2.1**</dt><dd>.NET Standard 2.1 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dt>**netcoreapp2.1**</dt><dd>.NET Core 2.1 compatible</dd><dt>**netcoreapp3.0**</dt><dd>.NET Core 3.0 compatible</dd><dt>**netcoreapp3.1**</dt><dd>.NET Core 3.1 compatible</dd><dt>**net47**</dt><dd>.NET Framework 4.7 compatible</dd><dt>**net5.0**</dt><dd>.NET 5.0 compatible</dd></dl>|netstandard2.0|
|useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false| |useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.| |false| |useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
|validatable|Generates self-validatable models.| |true|
## IMPORT MAPPING ## IMPORT MAPPING
@ -110,6 +108,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>Version</li> <li>Version</li>
<li>abstract</li> <li>abstract</li>
<li>as</li> <li>as</li>
<li>async</li>
<li>await</li>
<li>base</li> <li>base</li>
<li>bool</li> <li>bool</li>
<li>break</li> <li>break</li>
@ -127,6 +127,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>delegate</li> <li>delegate</li>
<li>do</li> <li>do</li>
<li>double</li> <li>double</li>
<li>dynamic</li>
<li>else</li> <li>else</li>
<li>enum</li> <li>enum</li>
<li>event</li> <li>event</li>
@ -196,10 +197,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
<li>unsafe</li> <li>unsafe</li>
<li>ushort</li> <li>ushort</li>
<li>using</li> <li>using</li>
<li>var</li>
<li>virtual</li> <li>virtual</li>
<li>void</li> <li>void</li>
<li>volatile</li> <li>volatile</li>
<li>while</li> <li>while</li>
<li>yield</li>
</ul> </ul>
## FEATURE SET ## FEATURE SET
@ -208,9 +211,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl
### Client Modification Feature ### Client Modification Feature
| Name | Supported | Defined By | | Name | Supported | Defined By |
| ---- | --------- | ---------- | | ---- | --------- | ---------- |
|BasePath|✓|ToolingExtension |BasePath|✗|ToolingExtension
|Authorizations|✗|ToolingExtension |Authorizations|✗|ToolingExtension
|UserAgent|✓|ToolingExtension |UserAgent|✗|ToolingExtension
|MockServer|✗|ToolingExtension |MockServer|✗|ToolingExtension
### Data Type Feature ### Data Type Feature
@ -297,8 +300,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|BasicAuth|✓|OAS2,OAS3 |BasicAuth|✓|OAS2,OAS3
|ApiKey|✓|OAS2,OAS3 |ApiKey|✓|OAS2,OAS3
|OpenIDConnect|✗|OAS3 |OpenIDConnect|✗|OAS3
|BearerToken|✗|OAS3 |BearerToken|✓|OAS3
|OAuth2_Implicit|✓|OAS2,OAS3 |OAuth2_Implicit|✗|OAS2,OAS3
|OAuth2_Password|✗|OAS2,OAS3 |OAuth2_Password|✗|OAS2,OAS3
|OAuth2_ClientCredentials|✗|OAS2,OAS3 |OAuth2_ClientCredentials|✗|OAS2,OAS3
|OAuth2_AuthorizationCode|✗|OAS2,OAS3 |OAuth2_AuthorizationCode|✗|OAS2,OAS3

4
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpNetcoreFunctionsServerCodegen.java
View File

@ -230,10 +230,6 @@ public class CsharpNetcoreFunctionsServerCodegen extends AbstractCSharpCodegen {
"Suffix that will be appended to all enum values.", "Suffix that will be appended to all enum values.",
enumValueSuffix); enumValueSuffix);
addSwitch(GENERATE_BODY,
"Generates method body.",
generateBody);
classModifier.addEnum("", "Keep class default with no modifier"); classModifier.addEnum("", "Keep class default with no modifier");
classModifier.addEnum("abstract", "Make class abstract"); classModifier.addEnum("abstract", "Make class abstract");
classModifier.setDefault(""); classModifier.setDefault("");