config.yaml

#
# OpenAPI generator configuration
#

modelNamePrefix: ""
# Prefix that will be prepended to all model names.

modelNameSuffix: ""
# Suffix that will be appended to all model names.

#artifactId <artifact id>
# artifactId in generated pom.xml.
# This also becomes part of the generated library's filename

#artifactVersion <artifact version>
# artifact version in generated pom.xml.
# This also becomes part of the generated library's filename

#auth <authorization>
# adds authorization headers when fetching the OpenAPI definitions remotely.
# Pass in a URL-encoded string of name:header with a comma separating multiple values

#dryRun
# Try things out and report on potential changes (without actually making changes).

engine: "mustache"
# templating engine: "mustache" (default) or "handlebars" (beta)

enablePostProcessFile: false
# Enable post-processing file using environment variables.
# Set to true if you want to use uncrustify for code formatting.

#generateAliasAsModel
# Generate model implementation for aliases to map and array schemas.
# An 'alias' is an array, map, or list which is defined inline in a OpenAPI document
# and becomes a model in the generated code.
# A 'map' schema is an object that can have undeclared properties,
# i.e. the 'additionalproperties' attribute is set on that object.
# An 'array' schema is a list of sub schemas in a OAS document

#globalProperty <global properties>
# sets specified global properties (previously called 'system properties')
# in the format of name=value,name=value (or multiple options, each with name=value)

#groupId <group id>
# groupId in generated pom.xml

#httpUserAgent <http user agent>
# HTTP user agent, e.g. codegen_csharp_api_client, default to 'OpenAPI-Generator/{packageVersion}/{language}'

#importMappings <import mappings>
# specifies mappings between a given class
# and the import that should be used for that class in the format of type=import,type=import.
# You can also have multiple occurrences of this option.

#inlineSchemaNameMappings <inline schema name mappings>
# specifies mappings between the inline schema name and the new name in the format of
# inline_object_2=Cat,inline_object_5=Bird.
# You can also have multiple occurrences of this option.

#inlineSchemaOptions <inline schema options>
# specifies the options for handling inline schemas in the inline model resolver.
# Please refer to https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md for a list of options.

#inputSpecRootDirectory <Folder with spec(s)>
# Local root folder with spec file(s)

#instantiationTypes <instantiation types>
# sets instantiation type mappings in the format of type=instantiatedType,type=instantiatedType.
# For example (in Java):
# array=ArrayList,map=HashMap.
# In other words array types will get instantiated as ArrayList in generated code.
# You can also have multiple occurrences of this option.

#invokerPackage <invoker package>
# root package for generated code

#languageSpecificPrimitives <language specific primitives>
# specifies additional language specific primitive types in the format of type1,type2,type3,type3.
# For example:
# String,boolean,Boolean,Double.
# You can also have multiple occurrences of this option.

#legacyDiscriminatorBehavior
# Set to false for generators with better support for discriminators.
# (Python, Java, Go, PowerShell, C# have this enabled by default).

#logToStderr
# write all log messages (not just errors) to STDOUT.
# Useful for piping the JSON output of debug options (e.g. `--global-property debugOperations`)
# to an external parser directly while testing a generator.

#mergedSpecFilename <Name of resulted merged specs file (used along with --input-spec-root-directory option)>

#minimalUpdate
# Only write output files that have changed.

#modelNameMappings <model name mappings>
# specifies mappings between the model name and the new name in the
# format of model_name=AnotherName,model_name2=OtherName2.
# You can also have multiple occurrences of this option.

#nameMappings <property name mappings>
# specifies mappings between the property name and the new name in the
# format of prop_name=PropName,prop_name2=PropName2.
# You can also have multiple occurrences of this option.

#openapiNormalizer <OpenAPI normalizer rules>
# specifies the rules to be enabled in OpenAPI normalizer in the form
# of RULE_1=true,RULE_2=original.
# You can also have multiple occurrences of this option.

#parameterNameMappings <parameter name mappings>
# specifies mappings between the parameter name and the new name in
# the format of param_name=paramName,param_name2=paramName2. You can
# also have multiple occurrences of this option.

releaseNote: "Minor update"
# Release note, default to 'Minor update'. (Default: Minor update)

removeOperationIdPrefix: true
# Remove prefix of operationId, e.g. config_getId => getId

#reservedWordsMappings <reserved word mappings>
# specifies how a reserved name should be escaped to. Otherwise, the
# default _<name> is used. For example id=identifier. You can also
# have multiple occurrences of this option.

#skipOverwrite
# specifies if the existing files should be overwritten during the generation.

#schemaMappings <schema mappings>
# specifies mappings between the schema and the new name in the format
# of schema_a=Cat,schema_b=Bird.
# You can also have multiple occurrences of this option.

#serverVariables <server variables>
# sets server variables overrides for spec documents which support variable templating of servers.

#skipOperationExample
# Skip examples defined in operations to avoid out of memory errors.

#skipValidateSpec
# Skips the default behavior of validating an input specification.

#strictSpec <true/false strict behavior>
# 'MUST' and 'SHALL' wording in OpenAPI spec is strictly adhered to.
# e.g. when false, no fixes will be applied to documents which pass validation but don't follow the spec.

#templateDir <template directory>
# folder containing the template files

#typeMappings <type mappings>
# sets mappings between OpenAPI spec types and generated code types
#  in the format of OpenAPIType=generatedType,OpenAPIType=generatedType.
# For example:
# array=List,map=Map,string=String.
# You can also have multiple occurrences of this option.
# To map a specified format, use type+format,
# e.g. string+password=EncryptedString will map `type: string, format: password` to `EncryptedString`.

verbose: false
# verbose mode

additionalProperties:
  # # Custom # #
  environmentDevelopmentUrl: https://dev-oxs.simplic.io
  # Url for Environment.Development

  environmentProductionUrl: https://oxs.simplic.io
  # Url for Environment.Production

  apiVersion: v1
  # API version as used in https://oxs.simplic.io/example-api/<apiVersion>

  withHttpInfoSuffix: WithHttpInfo
  # Suffix for calls that shall return a wrapped result (ApiResponse) containing http info (Default: WithHttpInfo).
  # # # -- # # #

  allowUnicodeIdentifiers: false
  # boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)

  caseInsensitiveResponseHeaders: false
  # Make API response's headers case-insensitive (Default: false)

  conditionalSerialization: false
  # Serialize only those properties which are initialized by user, accepted values are true or false, default value is false. (Default: false)

  dateFormat: "yyy'-'MM'-'dd"
  # The default Date format (only `generichost` library supports this option). (Default: yyyy'-'MM'-'dd)

  dateTimeFormat: "yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK"
  # The default DateTime format (only `generichost` library supports this option). (Default: yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK)

  disallowAdditionalPropertiesIfNotPresent: true
  # 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. (Default: true)
  #   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.

  equatable: true
  # Overrides Equals and GetHashCode methods. (Default: true)

  hideGenerationTimestamp: true
  # Hides the generation timestamp when files are generated. (Default: true)

  interfacePrefix: "I"
  # Prefix interfaces with a community standard or widely accepted prefix. (Default: I)

  library: "restsharp"
  # HTTP library template (sub-template) to use (Default: restsharp)
  #   generichost - HttpClient with Generic Host dependency injection (https://docs.microsoft.com/en-us/dotnet/core/extensions/generic-host) (Experimental. Subject to breaking changes without notice.)
  #   httpclient - HttpClient (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. Subject to breaking changes without notice.)
  #   unityWebRequest - UnityWebRequest (...) (Experimental. Subject to breaking changes without notice.)
  #   restsharp - RestSharp (https://github.com/restsharp/RestSharp)

  #licenseId
  # The identifier of the license

  modelPropertyNaming: PascalCase
  # Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: PascalCase)

  netCoreProjectFile: false
  # Use the new format (.NET Core) for .NET project files (.csproj). (Default: false)

  nonPublicApi: false
  # Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers. (Default: false)

  nullableReferenceTypes: true
  # Use nullable annotations in the project.
  # Only supported on C# 8 / ASP.NET Core 3.1 or newer. Starting in .NET 6.0 the default is true. (Default: false)

  optionalAssemblyInfo: true
  # Generate AssemblyInfo.cs. (Default: true)

  optionalEmitDefaultValues: false
  # Set DataMember's EmitDefaultValue. (Default: false)

  optionalMethodArgument: true
  # C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only). (Default: true)

  optionalProjectFile: true
  # Generate {PackageName}.csproj. (Default: true)

  #packageGuid
  # The GUID that will be associated with the C# project

  packageTags: "Simplic,SDK"
  # Tags to identify the package

  packageVersion: "1.0.0"
  # C# package version. (Default: 1.0.0)

  returnICollection: false
  # Return ICollection<T> instead of the concrete type. (Default: false)

  targetFramework: "netstandard2.0"
  # The target .NET framework version.
  # To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1` (Default: net7.0)
  #   netstandard1.3 - .NET Standard 1.3
  #   netstandard1.4 - .NET Standard 1.4
  #   netstandard1.5 - .NET Standard 1.5
  #   netstandard1.6 - .NET Standard 1.6
  #   netstandard2.0 - .NET Standard 2.0
  #   netstandard2.1 - .NET Standard 2.1
  #   net47 - .NET Framework 4.7
  #   net48 - .NET Framework 4.8
  #   net6.0 - .NET 6.0 (End of Support 12 November 2024)
  #   net7.0 - .NET 7.0

  useCollection: false
  # Deserialize array types to Collection<T> instead of List<T>. (Default: false)

  useDateTimeOffset: false
  # Use DateTimeOffset to model date-time properties (Default: false)

  useOneOfDiscriminatorLookup: false
  # 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. (Default: false)

  useSourceGeneration: false
  # Use source generation where available (only `generichost` library supports this option). (Default: false)

  validatable: true
  # Generates self-validatable models. (Default: true)

  zeroBasedEnums: true
  # Enumerations with string values will start from 0 when true, 1 when false.
  # If not set, enumerations with string values will start from 0 if the first value is 'unknown', case insensitive.