valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 10:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
08c93578d4
openapi-generator/docs/generators/html2.md
Jim Schubert a496c2011f
[docs] Initial FeatureSet generator documentation (#5188) 
* Flatten feature sets for display

* [cli] Add feature set output to config-help

This includes markdown and plain text outputs for config-help.

* [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00

4.8 KiB
Raw Blame History

title sidebar_label
Config Options for html2 html2
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
appDescription description of the application null
appName short name of the application null
artifactId artifactId in generated pom.xml. This also becomes part of the generated library's filename null
artifactVersion artifact version in generated pom.xml. This also becomes part of the generated library's filename null
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
groupId groupId in generated pom.xml null
infoEmail an email address to contact for inquiries about the application null
infoUrl a URL where users can get more information about the application null
invokerPackage root package for generated code null
licenseInfo a short description of the license null
licenseUrl a URL pointing to the full license null
packageName C# package name null
perlModuleName root module name for generated perl code null
phpInvokerPackage root package for generated php code null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
pythonPackageName package name for generated python code 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

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

    RESERVED WORDS

      FEATURE SET

      Client Modification Feature

      Name Supported Defined By
      BasePath ✗ ToolingExtension
      Authorizations ✗ ToolingExtension
      UserAgent ✗ 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