Package org.openapitools.codegen.languages

Class TypeScriptFetchClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

All Implemented Interfaces:

CodegenConfig

public class TypeScriptFetchClientCodegen
extends AbstractTypeScriptClientCodegen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TypeScriptFetchClientCodegen.ExtendedCodegenModel
class	TypeScriptFetchClientCodegen.ExtendedCodegenOperation
class	TypeScriptFetchClientCodegen.ExtendedCodegenParameter
class	TypeScriptFetchClientCodegen.ExtendedCodegenProperty

Nested classes/interfaces inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

AbstractTypeScriptClientCodegen.ParameterExpander

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addedApiIndex
protected boolean	addedModelIndex
static String	CAMEL_CASE
static String	DETECT_PASSTHROUGH_MODELS_WITH_SUFFIX_AND_FIELD
protected String	detectPassthroughModelsWithSuffixAndField
static String	FILE_NAMING
protected String	fileNaming
static String	IMPORT_FILE_EXTENSION_SWITCH
static String	IMPORT_FILE_EXTENSION_SWITCH_DESC
protected String	importFileExtension
static String	INFER_ENTITY_FROM_UNIQUE_ID_WITH_NAME
static String	INFER_UNIQUE_ID_FROM_NAME_SUFFIX
protected String	inferEntityFromUniqueIdWithName
protected boolean	inferUniqueIdFromNameSuffix
static String	KEBAB_CASE
static String	NPM_REPOSITORY
protected String	npmRepository
static String	PACKAGE_AS_SOURCE_ONLY_LIBRARY
protected boolean	packageAsSourceOnlyLibrary
static String	PASCAL_CASE
static String	PREFIX_PARAMETER_INTERFACES
static String	SAGAS_AND_RECORDS
protected boolean	sagasAndRecords
static String	STRING_ENUMS
static String	STRING_ENUMS_DESC
protected boolean	stringEnums
static String	USE_SINGLE_REQUEST_PARAMETER
static String	USE_SQUARE_BRACKETS_IN_ARRAY_NAMES
static String	WITH_INTERFACES
static String	WITHOUT_RUNTIME_CHECKS
protected boolean	withoutRuntimeChecks

Fields inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

classEnumSeparator, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC, enumPropertyNaming, enumPropertyNamingReplaceSpecialChar, enumSuffix, languageGenericTypes, MODEL_PROPERTY_NAMING_DESC_WITH_WARNING, modelPropertyNaming, NPM_NAME, NPM_VERSION, npmName, npmVersion, NULL_SAFE_ADDITIONAL_PROPS, NULL_SAFE_ADDITIONAL_PROPS_DESC, nullSafeAdditionalProps, paramNaming, SNAPSHOT, SNAPSHOT_SUFFIX_FORMAT, supportsES6

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors

Constructor	Description
TypeScriptFetchClientCodegen()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)	Handle the model for the 'additionalProperties' keyword in the OAS schema.
protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda>	addMustacheLambdas()	Preset map builder with commonly used Mustache lambdas.
String	escapeReservedWord(String name)	Return the escaped name of the reserved word
CodegenParameter	fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports)
TypeScriptFetchClientCodegen.ExtendedCodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema model)	Convert OAS Model object to Codegen Model object.
TypeScriptFetchClientCodegen.ExtendedCodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)	Convert OAS Operation object to Codegen Operation object
TypeScriptFetchClientCodegen.ExtendedCodegenParameter	fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports)	Convert OAS Parameter object to Codegen Parameter object
TypeScriptFetchClientCodegen.ExtendedCodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p, boolean required)	TODO remove this in 7.0.0 as a breaking change This method was kept when required was added to the fromProperty signature to ensure that the change was non-breaking
CodegenParameter	fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName)
List<CodegenParameter>	fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports)
protected String	getEnumDefaultValue(String defaultValue, String dataType)
String	getHelp()
boolean	getInferUniqueIdFromNameSuffix()
String	getName()
boolean	getPackageAsSourceOnlyLibrary()
String	getPassthroughField()
String	getPassthroughSuffix()
Boolean	getSagasAndRecords()
Boolean	getStringEnums()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)	Output the language-specific type declaration of the property.
Boolean	getWithoutRuntimeChecks()
boolean	isUniqueIdAccordingToNameSuffix(String name)
Map<String,ModelsMap>	postProcessAllModels(Map<String,ModelsMap> objs)
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap operations, List<ModelMap> allModels)
void	postProcessParameter(CodegenParameter parameter)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setFileNaming(String fileNaming)	Set the file naming type.
void	setSagasAndRecords(Boolean sagasAndRecords)
void	setStringEnums(Boolean stringEnums)
void	setWithoutRuntimeChecks(Boolean withoutRuntimeChecks)
String	toApiFilename(String name)	Return the file name of the Api Test
String	toEnumDefaultValue(String value, String datatype)	Return the enum default value in the language specified format
String	toModelFilename(String name)	Return the capitalized file name of the model

Methods inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

addImport, addPrefix, addSuffix, apiFileFolder, escapeQuotationMark, escapeText, escapeUnsafeCharacters, generatorLanguage, getEnumPropertyNaming, getParameterDataType, getSchemaType, getTag, getTypesFromSchemas, isEnumPropertyNamingReplaceSpecialChar, isReservedWord, modelFileFolder, postProcessFile, preprocessOpenAPI, setEnumPropertyNaming, setEnumPropertyNamingReplaceSpecialChar, setModelPropertyNaming, setParamNaming, supportModelPropertyNaming, toAllOfName, toAnyOfName, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelImport, toModelImportMap, toModelName, toOneOfName, toOperationId, toParamName, toTypescriptTypeName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addBodyModelSchema, addHeaders, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromProperty, fromProperty, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getProducesInfo, getReleaseNote, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessResponseWithProperty, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setCircularReferences, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessModelProperty, postProcessResponseWithProperty, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

NPM_REPOSITORY

public static final String NPM_REPOSITORY

See Also:

Constant Field Values

WITH_INTERFACES

public static final String WITH_INTERFACES

See Also:

Constant Field Values

USE_SINGLE_REQUEST_PARAMETER

public static final String USE_SINGLE_REQUEST_PARAMETER

See Also:

Constant Field Values

PREFIX_PARAMETER_INTERFACES

public static final String PREFIX_PARAMETER_INTERFACES

See Also:

Constant Field Values

WITHOUT_RUNTIME_CHECKS

public static final String WITHOUT_RUNTIME_CHECKS

See Also:

Constant Field Values

STRING_ENUMS

public static final String STRING_ENUMS

See Also:

Constant Field Values

STRING_ENUMS_DESC

public static final String STRING_ENUMS_DESC

See Also:

Constant Field Values

IMPORT_FILE_EXTENSION_SWITCH

public static final String IMPORT_FILE_EXTENSION_SWITCH

See Also:

Constant Field Values

IMPORT_FILE_EXTENSION_SWITCH_DESC

public static final String IMPORT_FILE_EXTENSION_SWITCH_DESC

See Also:

Constant Field Values

FILE_NAMING

public static final String FILE_NAMING

See Also:

Constant Field Values

KEBAB_CASE

public static final String KEBAB_CASE

See Also:

Constant Field Values

CAMEL_CASE

public static final String CAMEL_CASE

See Also:

Constant Field Values

PASCAL_CASE

public static final String PASCAL_CASE

See Also:

Constant Field Values

USE_SQUARE_BRACKETS_IN_ARRAY_NAMES

public static final String USE_SQUARE_BRACKETS_IN_ARRAY_NAMES

See Also:

Constant Field Values

npmRepository

protected String npmRepository

importFileExtension

protected String importFileExtension

addedApiIndex

protected boolean addedApiIndex

addedModelIndex

protected boolean addedModelIndex

withoutRuntimeChecks

protected boolean withoutRuntimeChecks

stringEnums

protected boolean stringEnums

fileNaming

protected String fileNaming

SAGAS_AND_RECORDS

public static final String SAGAS_AND_RECORDS

See Also:

Constant Field Values

DETECT_PASSTHROUGH_MODELS_WITH_SUFFIX_AND_FIELD

public static final String DETECT_PASSTHROUGH_MODELS_WITH_SUFFIX_AND_FIELD

See Also:

Constant Field Values

INFER_UNIQUE_ID_FROM_NAME_SUFFIX

public static final String INFER_UNIQUE_ID_FROM_NAME_SUFFIX

See Also:

Constant Field Values

INFER_ENTITY_FROM_UNIQUE_ID_WITH_NAME

public static final String INFER_ENTITY_FROM_UNIQUE_ID_WITH_NAME

See Also:

Constant Field Values

PACKAGE_AS_SOURCE_ONLY_LIBRARY

public static final String PACKAGE_AS_SOURCE_ONLY_LIBRARY

See Also:

Constant Field Values

sagasAndRecords

protected boolean sagasAndRecords

detectPassthroughModelsWithSuffixAndField

protected String detectPassthroughModelsWithSuffixAndField

inferUniqueIdFromNameSuffix

protected boolean inferUniqueIdFromNameSuffix

inferEntityFromUniqueIdWithName

protected String inferEntityFromUniqueIdWithName

packageAsSourceOnlyLibrary

protected boolean packageAsSourceOnlyLibrary

Constructor Detail

TypeScriptFetchClientCodegen

public TypeScriptFetchClientCodegen()

Method Detail

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class AbstractTypeScriptClientCodegen

Parameters:

name - the model name

Returns:

the file name of the model

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

getWithoutRuntimeChecks

public Boolean getWithoutRuntimeChecks()

setWithoutRuntimeChecks

public void setWithoutRuntimeChecks(Boolean withoutRuntimeChecks)

getStringEnums

public Boolean getStringEnums()

setStringEnums

public void setStringEnums(Boolean stringEnums)

setFileNaming

public void setFileNaming(String fileNaming)

Set the file naming type.

Parameters:

fileNaming - the file naming to use

getSagasAndRecords

public Boolean getSagasAndRecords()

setSagasAndRecords

public void setSagasAndRecords(Boolean sagasAndRecords)

getPassthroughSuffix

public String getPassthroughSuffix()

getPassthroughField

public String getPassthroughField()

getInferUniqueIdFromNameSuffix

public boolean getInferUniqueIdFromNameSuffix()

getPackageAsSourceOnlyLibrary

public boolean getPackageAsSourceOnlyLibrary()

isUniqueIdAccordingToNameSuffix

public boolean isUniqueIdAccordingToNameSuffix(String name)

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractTypeScriptClientCodegen

toEnumDefaultValue

public String toEnumDefaultValue(String value,
                                 String datatype)

Description copied from class: DefaultCodegen

Return the enum default value in the language specified format

Overrides:

toEnumDefaultValue in class AbstractTypeScriptClientCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the default value for the enum

getEnumDefaultValue

protected String getEnumDefaultValue(String defaultValue,
                                     String dataType)

Overrides:

getEnumDefaultValue in class DefaultCodegen

addMustacheLambdas

protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> addMustacheLambdas()

Description copied from class: DefaultCodegen

Preset map builder with commonly used Mustache lambdas. To extend the map, override addMustacheLambdas(), call parent method first and then add additional lambdas to the returned builder. If common lambdas are not desired, override addMustacheLambdas() method and return empty builder.

Overrides:

addMustacheLambdas in class DefaultCodegen

Returns:

preinitialized map with common lambdas

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractTypeScriptClientCodegen

Parameters:

p - property schema

Returns:

a string presentation of the property type

addAdditionPropertiesToCodeGenModel

protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Handle the model for the 'additionalProperties' keyword in the OAS schema.

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegen

Parameters:

codegenModel - The codegen representation of the schema.

schema - The input OAS schema.

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractTypeScriptClientCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

postProcessAllModels

public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class AbstractTypeScriptClientCodegen

fromRequestBodyToFormParameters

public List<CodegenParameter> fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body,
                                                              Set<String> imports)

Overrides:

fromRequestBodyToFormParameters in class DefaultCodegen

fromParameter

public TypeScriptFetchClientCodegen.ExtendedCodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                                                           Set<String> imports)

Description copied from class: DefaultCodegen

Convert OAS Parameter object to Codegen Parameter object

Overrides:

fromParameter in class DefaultCodegen

Parameters:

parameter - OAS parameter object

imports - set of imports for library/package/module

Returns:

Codegen Parameter object

fromFormProperty

public CodegenParameter fromFormProperty(String name,
                                         io.swagger.v3.oas.models.media.Schema propertySchema,
                                         Set<String> imports)

Overrides:

fromFormProperty in class DefaultCodegen

fromRequestBody

public CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body,
                                        Set<String> imports,
                                        String bodyParameterName)

Overrides:

fromRequestBody in class DefaultCodegen

fromProperty

public TypeScriptFetchClientCodegen.ExtendedCodegenProperty fromProperty(String name,
                                                                         io.swagger.v3.oas.models.media.Schema p,
                                                                         boolean required)

Description copied from class: DefaultCodegen

TODO remove this in 7.0.0 as a breaking change This method was kept when required was added to the fromProperty signature to ensure that the change was non-breaking

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

p - OAS property schema

required - true if the property is required in the next higher object schema, false otherwise

Returns:

Codegen Property object

fromModel

public TypeScriptFetchClientCodegen.ExtendedCodegenModel fromModel(String name,
                                                                   io.swagger.v3.oas.models.media.Schema model)

Description copied from class: DefaultCodegen

Convert OAS Model object to Codegen Model object.

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

model - OAS Model object

Returns:

Codegen Model object

fromOperation

public TypeScriptFetchClientCodegen.ExtendedCodegenOperation fromOperation(String path,
                                                                           String httpMethod,
                                                                           io.swagger.v3.oas.models.Operation operation,
                                                                           List<io.swagger.v3.oas.models.servers.Server> servers)

Description copied from class: DefaultCodegen

Convert OAS Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - OAS operation object

servers - list of servers

Returns:

Codegen Operation object

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class AbstractTypeScriptClientCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap operations,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen