forked from loafle/openapi-generator-original
* Revert "Revert "Has generators set default template engine (#11245)" (#11316)" This reverts commit 57987424a4eaa22d73337388489cd86d7f42a023. * Only loads in the default template engine if the config file contains the generatorName * Only sets templatingEngineName using condif default in one place * Adds config files that lack generatorName * Revert "Adds config files that lack generatorName" This reverts commit 7dafc93c0f02c037d9be5d2c0a3ee7377c8b479d. * Adds generator default templating engine to the generator metadata
10 KiB
10 KiB
title |
---|
Documentation for the swift4-deprecated Generator |
METADATA
Property | Value | Notes |
---|---|---|
generator name | swift4-deprecated | pass this to the generate command after -g |
generator stability | DEPRECATED | |
generator type | CLIENT | |
generator language | Swift | |
generator default templating engine | mustache | |
helpTxt | Generates a Swift 4.x client library (Deprecated and will be removed in 5.x releases. Please use swift5 instead.) |
CONFIG OPTIONS
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
Option | Description | Values | Default |
---|---|---|---|
allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | false | |
disallowAdditionalPropertiesIfNotPresent | If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. |
|
true |
ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | true | |
enumUnknownDefaultCase | If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case. |
|
false |
hideGenerationTimestamp | Hides the generation timestamp when files are generated. | true | |
legacyDiscriminatorBehavior | Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default). |
|
true |
lenientTypeCast | Accept and cast values for simple types (string->bool, string->int, int->string) | false | |
nonPublicApi | Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false) | null | |
objcCompatible | Add additional properties and methods for Objective-C compatibility (default: false) | null | |
podAuthors | Authors used for Podspec | null | |
podDescription | Description used for Podspec | null | |
podDocsetURL | Docset URL used for Podspec | null | |
podDocumentationURL | Documentation URL used for Podspec | null | |
podHomepage | Homepage used for Podspec | null | |
podLicense | License used for Podspec | null | |
podScreenshots | Screenshots used for Podspec | null | |
podSocialMediaURL | Social Media URL used for Podspec | null | |
podSource | Source information used for Podspec | null | |
podSummary | Summary used for Podspec | null | |
podVersion | Version used for Podspec | null | |
prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | false | |
projectName | Project name in Xcode | null | |
responseAs | Optionally use libraries to manage response. Currently PromiseKit, RxSwift, Result are available. | null | |
sortModelPropertiesByRequiredFlag | Sort model properties to place required parameters before optional parameters. | true | |
sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | true | |
swiftUseApiNamespace | Flag to make all the API classes inner-class of {{projectName}}API | null | |
unwrapRequired | Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema | null |
IMPORT MAPPING
Type/Alias | Imports |
---|
INSTANTIATION TYPES
Type/Alias | Instantiated By |
---|
LANGUAGE PRIMITIVES
- Any
- AnyObject
- Bool
- Character
- Data
- Date
- Decimal
- Double
- Float
- Int
- Int32
- Int64
- String
- URL
- UUID
- Void
RESERVED WORDS
- #available
- #colorLiteral
- #column
- #else
- #elseif
- #endif
- #file
- #fileLiteral
- #function
- #if
- #imageLiteral
- #line
- #selector
- #sourceLocation
- Any
- AnyObject
- Array
- Bool
- COLUMN
- Character
- Class
- ClosedRange
- Codable
- CountableClosedRange
- CountableRange
- Data
- Decodable
- Dictionary
- Double
- Encodable
- Error
- ErrorResponse
- FILE
- FUNCTION
- Float
- Float32
- Float64
- Float80
- Int
- Int16
- Int32
- Int64
- Int8
- LINE
- OptionSet
- Optional
- Protocol
- Range
- Response
- Self
- Set
- StaticString
- String
- Type
- UInt
- UInt16
- UInt32
- UInt64
- UInt8
- URL
- Unicode
- Void
- _
- as
- associatedtype
- associativity
- break
- case
- catch
- class
- continue
- convenience
- default
- defer
- deinit
- didSet
- do
- dynamic
- dynamicType
- else
- enum
- extension
- fallthrough
- false
- fileprivate
- final
- for
- func
- get
- guard
- if
- import
- in
- indirect
- infix
- init
- inout
- internal
- is
- lazy
- left
- let
- mutating
- nil
- none
- nonmutating
- open
- operator
- optional
- override
- postfix
- precedence
- prefix
- private
- protocol
- public
- repeat
- required
- rethrows
- return
- right
- self
- set
- static
- struct
- subscript
- super
- switch
- throw
- throws
- true
- try
- typealias
- unowned
- var
- weak
- where
- while
- willSet
FEATURE SET
Client Modification Feature
Name | Supported | Defined By |
---|---|---|
BasePath | ✗ | ToolingExtension |
Authorizations | ✗ | ToolingExtension |
UserAgent | ✗ | ToolingExtension |
MockServer | ✗ | ToolingExtension |
Data Type Feature
Name | Supported | Defined By |
---|---|---|
Custom | ✗ | OAS2,OAS3 |
Int32 | ✓ | OAS2,OAS3 |
Int64 | ✓ | OAS2,OAS3 |
Float | ✓ | OAS2,OAS3 |
Double | ✓ | OAS2,OAS3 |
Decimal | ✓ | ToolingExtension |
String | ✓ | OAS2,OAS3 |
Byte | ✓ | OAS2,OAS3 |
Binary | ✓ | OAS2,OAS3 |
Boolean | ✓ | OAS2,OAS3 |
Date | ✓ | OAS2,OAS3 |
DateTime | ✓ | OAS2,OAS3 |
Password | ✓ | OAS2,OAS3 |
File | ✓ | OAS2 |
Array | ✓ | OAS2,OAS3 |
Maps | ✓ | ToolingExtension |
CollectionFormat | ✓ | OAS2 |
CollectionFormatMulti | ✓ | OAS2 |
Enum | ✓ | OAS2,OAS3 |
ArrayOfEnum | ✓ | ToolingExtension |
ArrayOfModel | ✓ | ToolingExtension |
ArrayOfCollectionOfPrimitives | ✓ | ToolingExtension |
ArrayOfCollectionOfModel | ✓ | ToolingExtension |
ArrayOfCollectionOfEnum | ✓ | ToolingExtension |
MapOfEnum | ✓ | ToolingExtension |
MapOfModel | ✓ | ToolingExtension |
MapOfCollectionOfPrimitives | ✓ | ToolingExtension |
MapOfCollectionOfModel | ✓ | ToolingExtension |
MapOfCollectionOfEnum | ✓ | ToolingExtension |
Documentation Feature
Name | Supported | Defined By |
---|---|---|
Readme | ✗ | ToolingExtension |
Model | ✓ | ToolingExtension |
Api | ✓ | ToolingExtension |
Global Feature
Name | Supported | Defined By |
---|---|---|
Host | ✓ | OAS2,OAS3 |
BasePath | ✓ | OAS2,OAS3 |
Info | ✓ | OAS2,OAS3 |
Schemes | ✗ | OAS2,OAS3 |
PartialSchemes | ✓ | OAS2,OAS3 |
Consumes | ✓ | OAS2 |
Produces | ✓ | OAS2 |
ExternalDocumentation | ✓ | OAS2,OAS3 |
Examples | ✓ | OAS2,OAS3 |
XMLStructureDefinitions | ✗ | OAS2,OAS3 |
MultiServer | ✗ | OAS3 |
ParameterizedServer | ✗ | OAS3 |
ParameterStyling | ✗ | OAS3 |
Callbacks | ✗ | OAS3 |
LinkObjects | ✗ | OAS3 |
Parameter Feature
Name | Supported | Defined By |
---|---|---|
Path | ✓ | OAS2,OAS3 |
Query | ✓ | OAS2,OAS3 |
Header | ✓ | OAS2,OAS3 |
Body | ✓ | OAS2 |
FormUnencoded | ✓ | OAS2 |
FormMultipart | ✓ | OAS2 |
Cookie | ✗ | OAS3 |
Schema Support Feature
Name | Supported | Defined By |
---|---|---|
Simple | ✓ | OAS2,OAS3 |
Composite | ✓ | OAS2,OAS3 |
Polymorphism | ✓ | OAS2,OAS3 |
Union | ✗ | OAS3 |
Security Feature
Name | Supported | Defined By |
---|---|---|
BasicAuth | ✓ | OAS2,OAS3 |
ApiKey | ✓ | OAS2,OAS3 |
OpenIDConnect | ✗ | OAS3 |
BearerToken | ✗ | OAS3 |
OAuth2_Implicit | ✓ | OAS2,OAS3 |
OAuth2_Password | ✗ | OAS2,OAS3 |
OAuth2_ClientCredentials | ✗ | OAS2,OAS3 |
OAuth2_AuthorizationCode | ✗ | OAS2,OAS3 |
Wire Format Feature
Name | Supported | Defined By |
---|---|---|
JSON | ✓ | OAS2,OAS3 |
XML | ✗ | OAS2,OAS3 |
PROTOBUF | ✗ | ToolingExtension |
Custom | ✗ | OAS2,OAS3 |