Config Options for objc

OptionDescriptionValuesDefault
authorEmailEmail to use in the podspec file.team@openapitools.org
authorNameName to use in the podspec file.OpenAPI
classPrefixprefix for generated classes (convention: Abbreviation of pod name e.g. HN for HackerNews).`OAI
coreDataShould generate core data modelsfalse
gitRepoURLURL for the git repo where this podspec should point to.https://github.com/openapitools/openapi-generator
hideGenerationTimestampHides the generation timestamp when files are generated.true
podNamecocoapods package name (convention: CameCase).OpenAPIClient
podVersioncocoapods package version.1.0.0

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By
arrayNSMutableArray
mapNSMutableDictionary

LANGUAGE PRIMITIVES

  • BOOL
  • NSData
  • NSDate
  • NSNumber
  • NSObject
  • NSString
  • NSURL
  • bool

RESERVED WORDS

  • _packed
  • authsettings
  • auto
  • bodyparam
  • break
  • case
  • cgfloat
  • char
  • class
  • const
  • continue
  • default
  • description
  • do
  • double
  • else
  • enum
  • extern
  • float
  • for
  • formparams
  • goto
  • headerparams
  • id
  • if
  • implementation
  • int
  • interface
  • localvarfiles
  • long
  • nonatomic
  • nsinteger
  • nsnumber
  • nsobject
  • pathparams
  • property
  • protocol
  • queryparams
  • readonly
  • readwrite
  • register
  • requestcontenttype
  • resourcepath
  • responsecontenttype
  • retain
  • return
  • short
  • signed
  • sizeof
  • static
  • strong
  • struct
  • switch
  • typedef
  • union
  • unsafe_unretained
  • unsigned
  • void
  • volatile
  • weak
  • while

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
ArrayOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3
Last updated on by Diogo Nunes