latest--python.schema

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

Schema for configuration specific to a python SDK

Properties

packageName string required

The distribution name of the PyPI Package. https://docs.python.org/3.11/distutils/setupscript.html#additional-meta-data

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

The current version of the SDK

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

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

defaultErrorName string

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

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

A short description of the project. https://python-poetry.org/docs/pyproject/#description

documentationUrl

The URL for the documentation of the project. https://python-poetry.org/docs/pyproject/#documentation

enableCustomCodeRegions boolean

Allow custom code to be inserted into the generated SDK.

enumFormat string

Determines the format to express enums in Python

pattern=^(union|enum)$
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

flattenRequests boolean

Turn request parameters and body fields into a flat list of method arguments. This takes precedence over maxMethodParams. If there is no request body then maxMethodParams will be respected.

flatteningOrder string

When flattening parameters and body fields, determines the ordering of generated method arguments.

pattern=^(parameters-first|body-first)$
homepage

The URL for the homepage of the project. https://python-poetry.org/docs/pyproject/#homepage

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.\-_]+$
responseFormat string

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

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

The template version to use

pattern=^v\d+$