Config Options for erlang-server

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
openAPISpecNameOpenapi Spec Name.openapi
packageNameErlang package name (convention: lowercase).openapi

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By

LANGUAGE PRIMITIVES

    RESERVED WORDS

    • after
    • and
    • andalso
    • band
    • begin
    • bnot
    • bor
    • bsl
    • bsr
    • bxor
    • case
    • catch
    • cond
    • div
    • end
    • fun
    • if
    • let
    • not
    • of
    • or
    • orelse
    • receive
    • rem
    • try
    • when
    • xor

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePathToolingExtension
    AuthorizationsToolingExtension
    UserAgentToolingExtension
    MockServerToolingExtension

    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 patst