latest--php.schema

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

Schema for configuration specific to a php SDK

Properties

namespace string required

https://www.php.net/manual/en/language.namespaces.rationale.php

pattern=^([a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*\\)*[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$
packageName string required

The name of the composer package. https://getcomposer.org/doc/04-schema.md#name

pattern=^[a-z0-9]([_.-]?[a-z0-9]+)*\/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*
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 thrown when an API error occurs.

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

The environment variable prefix for laravel service provider env variable overrides. If empty these overrides will not be prefixed

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. PHP only supports infer-optional-args - this configuration option is only here for consistency.

pattern=^infer-optional-args$
outputModelSuffix string

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

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