Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 1.06 KB

API.md

File metadata and controls

22 lines (17 loc) · 1.06 KB

API

openapi-ts-sdk-builder

openapi-ts-sdk-builder~generateSDKFromOpenAPI(openAPIContent, options, [typeOptions]) ⇒ Promise.<string>

Build a JS SDK from an OpenAPI file

Kind: inner method of openapi-ts-sdk-builder
Returns: Promise.<string> - The SDK JS code

Param Type Description
openAPIContent string
options Object
options.sdkVersion string The SDK version
[options.sdkName] string The SDK name (default to API)
[options.ignoredParametersNames] Array.<string> Provide a list of parameters to ignore
[options.undocumentedParametersNames] Array.<string> Provide a list of parameters to keep undocumented
[typeOptions] Object Options to be passed to the type generator