latest--go.schema

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

Schema for configuration specific to a go SDK

Properties

version string required

The current version of the SDK

pattern=^[\w0-9.\-_]+$
allowUnknownFieldsInWeakUnions boolean

Allow unknown fields in weak (undiscriminated) unions

clientServerStatusCodesAsErrors boolean

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

defaultErrorName string

The name of the default error type used to represent API errors

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

The environment variable prefix for security and global env variable overrides. If empty these overrides will not be possible

flattenGlobalSecurity boolean

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

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|require-security-and-request)$
outputModelSuffix string

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

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

The go module package name. https://go.dev/ref/mod#module-path.

pattern=^[\w0-9\-~]([\w0-9.\-_\/~]*[\w0-9\-~])?$
responseFormat string

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

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