From 8acc5023a8b60b34af0a334a3f6f1d70fd1dbda5 Mon Sep 17 00:00:00 2001 From: Oleh Kurpiak Date: Mon, 21 Mar 2022 06:50:19 +0200 Subject: [PATCH] [C#/.NET] remove duplicate CLI option (#11925) --- docs/generators/csharp-netcore-functions.md | 59 ++++++++++--------- .../CsharpNetcoreFunctionsServerCodegen.java | 4 -- 2 files changed, 31 insertions(+), 32 deletions(-) diff --git a/docs/generators/csharp-netcore-functions.md b/docs/generators/csharp-netcore-functions.md index bede0fc8f24..e10d60e064c 100644 --- a/docs/generators/csharp-netcore-functions.md +++ b/docs/generators/csharp-netcore-functions.md @@ -1,53 +1,51 @@ --- 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 | Property | Value | Notes | | -------- | ----- | ----- | | generator name | csharp-netcore-functions | pass this to the generate command after -g | -| generator stability | BETA | | +| generator stability | STABLE | | | generator type | SERVER | | | generator language | C# | | | generator default templating engine | mustache | | -| helpTxt | Generates a csharp server. | | +| helpTxt | Generates an ASP.NET Core Web API server. | | ## 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. + | Option | Description | Values | Default | | ------ | ----------- | ------ | ------- | -|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| -|conditionalSerialization|Serialize only those properties which are initialized by user, accepted values are true or false, default value is false.| |false| -|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.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true| -|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| -|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I| -|library|HTTP library template (sub-template) to use|
**httpclient**
HttpClient (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. May subject to breaking changes without further notice.)
**restsharp**
RestSharp (https://github.com/restsharp/RestSharp)
|restsharp| -|licenseId|The identifier of the license| |null| -|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| +|azureFunctionsVersion|Azure functions version: v4, v3|
**v4**
Azure Functions v4
**v3**
Azure Functions v3
|v4| +|buildTarget|Target to build an application or library|
**program**
Generate code for a standalone server
**library**
Generate code for a server abstract class library
|program| +|classModifier|Class Modifier for function classes: Empty string or abstract.| || +|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum| +|enumValueSuffix|Suffix that will be appended to all enum values.| |Enum| +|generateBody|Generates method body.| |true| +|licenseName|The name of the license| |NoLicense| +|licenseUrl|The URL of the license| |http://localhost| +|modelClassModifier|Model Class Modifier can be nothing or partial| |partial| +|netCoreVersion|.NET Core version: 6.0, 5.0, 3.1, 3.0|
**3.0**
.NET Core 3.0
**3.1**
.NET Core 3.1
**5.0**
.NET Core 5.0
**6.0**
.NET Core 6.0
|3.1| +|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| -|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| +|operationIsAsync|Set methods to async or sync (default).| |false| +|operationModifier|Operation Modifier can be virtual or abstract|
**virtual**
Keep method virtual
**abstract**
Make method abstract
|virtual| +|operationResultTask|Set methods result to Task<>.| |false| +|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| |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| -|releaseNote|Release note, default to 'Minor update'.| |Minor update| |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. To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1`|
**netstandard1.3**
.NET Standard 1.3 compatible
**netstandard1.4**
.NET Standard 1.4 compatible
**netstandard1.5**
.NET Standard 1.5 compatible
**netstandard1.6**
.NET Standard 1.6 compatible
**netstandard2.0**
.NET Standard 2.0 compatible
**netstandard2.1**
.NET Standard 2.1 compatible
**netcoreapp2.0**
.NET Core 2.0 compatible
**netcoreapp2.1**
.NET Core 2.1 compatible
**netcoreapp3.0**
.NET Core 3.0 compatible
**netcoreapp3.1**
.NET Core 3.1 compatible
**net47**
.NET Framework 4.7 compatible
**net5.0**
.NET 5.0 compatible
|netstandard2.0| |useCollection|Deserialize array types to Collection<T> instead of List<T>.| |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| -|validatable|Generates self-validatable models.| |true| +|useNewtonsoft|Uses the Newtonsoft JSON library.| |true| ## IMPORT MAPPING @@ -110,6 +108,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
  • Version
  • abstract
  • as
    • +
  • async
    • +
  • await
  • base
  • bool
  • break
    • @@ -127,6 +127,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
  • delegate
  • do
  • double
    • +
  • dynamic
  • else
  • enum
  • event
    • @@ -196,10 +197,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
  • unsafe
  • ushort
  • using
    • +
  • var
  • virtual
  • void
  • volatile
  • while
    • +
  • yield
    • ## FEATURE SET @@ -208,9 +211,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl ### Client Modification Feature | Name | Supported | Defined By | | ---- | --------- | ---------- | -|BasePath|✓|ToolingExtension +|BasePath|✗|ToolingExtension |Authorizations|✗|ToolingExtension -|UserAgent|✓|ToolingExtension +|UserAgent|✗|ToolingExtension |MockServer|✗|ToolingExtension ### Data Type Feature @@ -297,8 +300,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl |BasicAuth|✓|OAS2,OAS3 |ApiKey|✓|OAS2,OAS3 |OpenIDConnect|✗|OAS3 -|BearerToken|✗|OAS3 -|OAuth2_Implicit|✓|OAS2,OAS3 +|BearerToken|✓|OAS3 +|OAuth2_Implicit|✗|OAS2,OAS3 |OAuth2_Password|✗|OAS2,OAS3 |OAuth2_ClientCredentials|✗|OAS2,OAS3 |OAuth2_AuthorizationCode|✗|OAS2,OAS3 diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpNetcoreFunctionsServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpNetcoreFunctionsServerCodegen.java index 02ff5cbf273..632d2c1e7aa 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpNetcoreFunctionsServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpNetcoreFunctionsServerCodegen.java @@ -230,10 +230,6 @@ public class CsharpNetcoreFunctionsServerCodegen extends AbstractCSharpCodegen { "Suffix that will be appended to all enum values.", enumValueSuffix); - addSwitch(GENERATE_BODY, - "Generates method body.", - generateBody); - classModifier.addEnum("", "Keep class default with no modifier"); classModifier.addEnum("abstract", "Make class abstract"); classModifier.setDefault("");