Swift configuration options
This section details the available configuration options for the Swift SDK. All configuration is managed in the gen.yaml file under the swift section.
General configuration
Name
version
Required
true
Default Value
0.0.1
Description
The current version of the SDK.
packageName
Required
true
Default Value
OpenAPI
Description
The name of the Swift Package Manager (SPM) package.
author
Required
true
Default Value
Speakeasy
Description
The name of the author of the published package.
description
Required
true
Default Value
Swift Client SDK Generated by Speakeasy
Description
A short description of the SDK.
documentationBaseURL
Required
false
Default Value
""
Description
The base URL to the hosted documentation site.
Import management
Field
option
Required
false
Default Value
"openapi"
Description
Defines the type of import strategy. Typically set to
, indicating that the structure is based on the OpenAPI document.
paths
Required
false
Default Value
{}
Description
Customizes where different parts of the SDK (e.g., callbacks, errors, and operations) will be imported from.
Import paths
Component
callbacks
Default Value
models/callbacks
Description
The directory where callback models will be imported from.
errors
Default Value
models/errors
Description
The directory where error models will be imported from.
operations
Default Value
models/operations
Description
The directory where operation models (i.e., API endpoints) will be imported from.
shared
Default Value
models/components
Description
The directory for shared components, such as reusable schemas, and data models imported from the OpenAPI spec.
webhooks
Default Value
models/webhooks
Description
The directory for webhook models, if your SDK includes support for webhooks.
Last updated on