Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/speakeasy-generation-config-file/_shared/latest--csharp.schema.json
Parent schema speakeasy-generation-config-file
Type: object

Schema for configuration specific to a csharp SDK

Properties

packageName string required
pattern=^[\w0-9._]+$
version string required

The current version of the SDK

pattern=^[\w0-9.\-_]+$
author string
clientServerStatusCodesAsErrors boolean

Whether to treat 4xx and 5xx status codes as errors.

defaultErrorName string

The name of the default exception that is thrown when an API error occurs.

pattern=^[A-Z][a-zA-Z0-9]*$
disableNamespacePascalCasingApr2024 boolean

Whether to disable Pascal Casing sanitization on provided packageName when setting the root namespace and NuGet package ID.

dotnetVersion string

The version of .NET to target. net8.0 (default), net6.0 and net5.0 supported. https://learn.microsoft.com/en-us/dotnet/standard/frameworks

pattern=^(net5\.0|net6\.0|net8\.0)$
flattenGlobalSecurity boolean

Flatten the global security configuration if there is only a single option in the spec

flatteningOrder string

When flattening parameters and body fields, determines the ordering of generated method arguments. Leave empty to apply legacy ordering.

pattern=^(parameters-first|body-first)?$
includeDebugSymbols boolean

Whether to generate .pdb files and publish a .snupkg symbol package to NuGet.

inputModelSuffix string

The suffix to add to models with writeOnly fields that are created as input models

pattern=^[\w0-9.\-_]+$
maxMethodParams number

The maximum number of parameters a method can have before the resulting SDK endpoint is no longer 'flattened' and an input object is created instead. 0 will use input objects always. https://www.speakeasy.com/docs/customize-sdks/methods

pattern=^\d+$
methodArguments string

Determines how arguments for SDK methods are generated

pattern=^infer-optional-args$
outputModelSuffix string

The suffix to add to models with writeOnly fields that are created as input models

pattern=^[\w0-9.\-_]+$
packageTags string

Space-delimited list of tags and keywords used when searching for packages on NuGet.

responseFormat string

Determines the shape of the response envelope that is return from SDK methods

pattern=^(envelope|envelope-http|flat)$
sourceDirectory string

The name of the source directory. Default is "src"

pattern=^\w*$