Skip to content

Latest commit

 

History

History
240 lines (216 loc) · 5.67 KB

objc.md

File metadata and controls

240 lines (216 loc) · 5.67 KB
title
Documentation for the objc Generator

METADATA

Property Value Notes
generator name objc pass this to the generate command after -g
generator stability STABLE
generator type CLIENT
generator language Objective-C
generator default templating engine mustache
helpTxt Generates an Objective-C client library.

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
authorEmail Email to use in the podspec file. team@openapitools.org
authorName Name to use in the podspec file. OpenAPI
classPrefix prefix for generated classes (convention: Abbreviation of pod name e.g. HN for HackerNews).` OAI
coreData Should generate core data models false
gitRepoURL URL for the git repo where this podspec should point to. https://github.com/openapitools/openapi-generator
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
podName cocoapods package name (convention: CameCase). OpenAPIClient
podVersion cocoapods package version. 1.0.0

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By
array NSMutableArray
map NSMutableDictionary

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

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
Uuid ✗
Array ✓ OAS2,OAS3
Null ✗ OAS3
AnyType ✗ OAS2,OAS3
Object ✓ 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
allOf ✗ OAS2,OAS3
anyOf ✗ OAS3
oneOf ✗ OAS3
not ✗ 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
SignatureAuth ✗ OAS3
AWSV4Signature ✗ ToolingExtension

Wire Format Feature

Name Supported Defined By
JSON ✓ OAS2,OAS3
XML ✗ OAS2,OAS3
PROTOBUF ✗ ToolingExtension
Custom ✗ OAS2,OAS3