| title |
sidebar_label |
| Config Options for eiffel |
eiffel |
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
| Option |
Description |
Values |
Default |
| hideGenerationTimestamp |
Hides the generation timestamp when files are generated. |
|
true |
| packageName |
Eiffel Cluster name (convention: lowercase). |
|
openapi |
| packageVersion |
Eiffel package version. |
|
1.0.0 |
IMPORT MAPPING
| Type/Alias |
Imports |
| File |
FILE |
| List |
LIST |
| Map |
STRING_TABLE |
| Set |
SET |
| file |
FILE |
INSTANTIATION TYPES
| Type/Alias |
Instantiated By |
| array |
ARRAYED_LIST |
| list |
ARRAYED_LIST |
| map |
STRING_TABLE |
LANGUAGE PRIMITIVES
- BOOLEAN
- INTEGER_16
- INTEGER_32
- INTEGER_64
- INTEGER_8
- NATURAL_16
- NATURAL_32
- NATURAL_64
- NATURAL_8
- REAL_32
- REAL_64
RESERVED WORDS
- across
- agent
- alias
- all
- and
- as
- assign
- attached
- attribute
- check
- class
- convert
- create
- current
- debug
- deferred
- detachable
- do
- else
- elseif
- end
- ensure
- expanded
- export
- external
- false
- feature
- from
- frozen
- if
- implies
- inherit
- inspect
- invariant
- like
- local
- loop
- not
- note
- obsolete
- old
- once
- only
- or
- precursor
- redefine
- rename
- require
- rescue
- result
- retry
- select
- separate
- then
- true
- tuple
- undefine
- until
- variant
- void
- when
- xor
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 |