Skip to content

Latest commit

 

History

History
247 lines (223 loc) · 8.23 KB

python-flask.md

File metadata and controls

247 lines (223 loc) · 8.23 KB
Raw
title
Documentation for the python-flask Generator

METADATA

Property Value Notes
generator name python-flask pass this to the generate command after -g
generator stability STABLE
generator type SERVER
generator language Python
generator language version 3.5.2+
generator default templating engine mustache
helpTxt Generates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

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
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
controllerPackage controller package controllers
defaultController default controller default_controller
disallowAdditionalPropertiesIfNotPresent If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
 true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
enumUnknownDefaultCase If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
 false
featureCORS use flask-cors for handling CORS requests false
legacyDiscriminatorBehavior Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
 true
packageName python package name (convention: snake_case). openapi_server
packageVersion python package version. 1.0.0
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
pythonSrcRoot put python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.
serverPort TCP port to listen to in app.run 8080
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
testsUsePythonSrcRoot generates test under the pythonSrcRoot folder. false
useNose use the nose test framework false
usePythonSrcRootInImports include pythonSrcRoot in import namespaces. false

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

  • Dict
  • List
  • bool
  • bytes
  • date
  • datetime
  • dict
  • file
  • float
  • int
  • list
  • object
  • str

RESERVED WORDS

  • all_params
  • and
  • as
  • assert
  • async
  • auth_settings
  • await
  • base64
  • body_params
  • break
  • class
  • continue
  • date
  • def
  • del
  • elif
  • else
  • except
  • exec
  • false
  • field
  • finally
  • float
  • for
  • form_params
  • from
  • global
  • header_params
  • if
  • import
  • in
  • is
  • json
  • lambda
  • local_var_files
  • none
  • nonlocal
  • not
  • or
  • pass
  • path_params
  • print
  • property
  • query_params
  • raise
  • resource_path
  • return
  • schema
  • self
  • true
  • try
  • while
  • with
  • yield

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