openapi-generator/docs/generators/fsharp-functions.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

4.3 KiB

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
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!