loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/fsharp-functions.md
Justin Black a2b613c1b3
Fixes md docs (#6079) 
* Fixes md docs

* Separates out boolean enum options into legacyDiscriminatorBehaviorOpts

* Updates docs, adds true and false descriptions
2020-04-28 22:30:56 +08:00

8.1 KiB
Raw Permalink Blame History

title sidebar_label
Config Options for fsharp-functions fsharp-functions
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
legacyDiscriminatorBehavior This flag is used by OpenAPITools codegen to influence the processing of the discriminator attribute in OpenAPI documents. This flag has no impact if the OAS document does not use the discriminator attribute. The default value of this flag is set in each language-specific code generator (e.g. Python, Java, go...)using the method toModelName. Note to developers supporting a language generator in OpenAPITools; to fully support the discriminator attribute as defined in the OAS specification 3.x, language generators should set this flag to true by default; however this requires updating the mustache templates to generate a language-specific discriminator lookup function that iterates over {{#mappedModels}} and does not iterate over {{children}}, {{#anyOf}}, or {{#oneOf}}.
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
licenseName The name of the license NoLicense
licenseUrl The URL of the license http://localhost
packageAuthors Specifies Authors property in the .NET Core project file. OpenAPI
packageCopyright Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file. No Copyright
packageGuid The GUID that will be associated with the C# project null
packageName F# module name (convention: Title.Case). OpenAPI
packageTitle Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file. OpenAPI Library
packageVersion F# package version. 1.0.0
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
sourceFolder source folder for generated code OpenAPI/src

IMPORT MAPPING

Type/Alias Imports
IDictionary System.Collections.Generic

INSTANTIATION TYPES

Type/Alias Instantiated By
array list
list list
map IDictionary

LANGUAGE PRIMITIVES

  • Collection
  • DataTimeOffset
  • DateTime
  • Dictionary
  • Double
  • ICollection
  • Int32
  • Int64
  • List
  • String
  • System.IO.Stream
  • bool
  • byte[]
  • char
  • decimal
  • dict
  • double
  • float
  • float32
  • int
  • int16
  • int64
  • list
  • nativeint
  • obj
  • seq
  • single
  • string
  • uint16
  • uint32
  • uint64
  • unativeint

RESERVED WORDS

  • abstract
  • and
  • as
  • assert
  • async
  • await
  • base
  • begin
  • bool
  • break
  • byte
  • case
  • catch
  • char
  • checked
  • class
  • const
  • continue
  • decimal
  • default
  • delegate
  • do
  • done
  • double
  • downcast
  • downto
  • dynamic
  • elif
  • else
  • end
  • enum
  • event
  • exception
  • explicit
  • extern
  • false
  • finally
  • fixed
  • float
  • for
  • foreach
  • fun
  • function
  • if
  • in
  • inherit
  • inline
  • int
  • interface
  • internal
  • is
  • lazy
  • let
  • let!
  • localVarFileParams
  • localVarFormParams
  • localVarHeaderParams
  • localVarHttpContentType
  • localVarHttpContentTypes
  • localVarHttpHeaderAccept
  • localVarHttpHeaderAccepts
  • localVarPath
  • localVarPathParams
  • localVarPostBody
  • localVarQueryParams
  • localVarResponse
  • localVarStatusCode
  • lock
  • match
  • match!
  • member
  • module
  • mutable
  • namespace
  • new
  • not
  • null
  • of
  • open
  • option
  • or
  • override
  • params
  • private
  • public
  • raise
  • rec
  • return
  • return!
  • sealed
  • select
  • static
  • string
  • struct
  • then
  • to
  • true
  • try
  • type
  • upcast
  • use
  • use!
  • val
  • void
  • volatile
  • when
  • while
  • with
  • yield
  • yield!

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