openapi-generator/docs/generators/csharp-refactor.md
Jim Schubert 6fe9a52229 [feat][docs][website] Initial docusaurus based site (#1770)
* Iniital docusaurus based site

* Remove error about default local being used by String.format

* Change pinned users to represent global presence rather than alphabetical order pinning

* Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README)

* Add Font Awesome attribution footer

* Remove feature callout until it is completed

* Include NPM try it out section

* Improve "Getting Started" type docs

* Include new custom template documentation

* Updating templating and customization docs

* Add vendor extension docs

* Cleanup templating page(s).

* Move users to yaml file for easy edit.

* travis configuration, and baseUrl mods to image URLs

* [docs] Migrate FAQ, release summary  from wiki

FAQ has been split into multiple smaller documents to better categorize
and allow users to find what they're looking for (in docs folder or in
new website).

Release summary information (versioning strategy and cadence) has been
migrated from the Wiki and clarified a bit.

Also adds copy button for all code snippets in website.

* Copy current contributing/code of conduct to website

* [docs] Creating a new generator
2019-01-18 17:39:33 +08:00

2.4 KiB


id: generator-opts-client-csharp-refactor title: Config Options for csharp-refactor sidebar_label: csharp-refactor

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.
v3.5
.NET Framework 3.5 compatible
v4.0
.NET Framework 4.0 compatible
v4.5.2
.NET Framework 4.5.2+ compatible
v5.0
.NET Standard 1.3 compatible
uwp
Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0)
v4.5.2
modelPropertyNaming Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name PascalCase
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
optionalAssemblyInfo Generate AssemblyInfo.cs. true
optionalProjectFile Generate {PackageName}.csproj. true
optionalEmitDefaultValues Set DataMember's EmitDefaultValue. false
generatePropertyChanged Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file. false
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
validatable Generates self-validatable models. true