Class HaskellHttpClientCodegen
- java.lang.Object
-
- org.openapitools.codegen.DefaultCodegen
-
- org.openapitools.codegen.languages.HaskellHttpClientCodegen
-
- All Implemented Interfaces:
CodegenConfig
public class HaskellHttpClientCodegen extends DefaultCodegen implements CodegenConfig
-
-
Field Summary
-
Fields inherited from class org.openapitools.codegen.DefaultCodegen
additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, 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, openapiNormalizer, 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, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN
-
-
Constructor Summary
Constructors Constructor Description HaskellHttpClientCodegen()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation op, Map<String,List<CodegenOperation>> operations)Add operation to groupStringapiFileFolder()StringescapeIdentifier(String prefix, String name)StringescapeQuotationMark(String input)Escape single and/or double quote to avoid code injectionStringescapeReservedWord(String name)Return the escaped name of the reserved wordStringescapeText(String input)StringescapeUnsafeCharacters(String input)override with any special text escaping logic to handle unsafe characters so as to avoid code injectionStringfirstLetterToLower(String word)StringfirstLetterToUpper(String word)CodegenModelfromModel(String name, io.swagger.v3.oas.models.media.Schema mod)Convert OAS Model object to Codegen Model object.List<CodegenSecurity>fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemes)Convert map of OAS SecurityScheme objects to a list of Codegen Security objectsGeneratorLanguagegeneratorLanguage()StringgetHelp()StringgetName()StringgetSchemaType(io.swagger.v3.oas.models.media.Schema p)returns the OpenAPI type for the property.CodegenTypegetTag()StringgetTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)Output the language-specific type declaration of the property.booleanisDataTypeBinary(String dataType)booleanisDataTypeFile(String dataType)BooleanisDuplicate(String paramNameType, String dataType)Map<String,ModelsMap>postProcessAllModels(Map<String,ModelsMap> objs)voidpostProcessFile(File file, String fileType)Post-process the auto-generated file, e.g.ModelsMappostProcessModels(ModelsMap objs)ModelsMappostProcessModelsEnum(ModelsMap objs)post process enum defined in model's propertiesOperationsMappostProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)Map<String,Object>postProcessSupportingFileData(Map<String,Object> objs)voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)voidprocessOpts()voidsetAllowFromJsonNulls(Boolean value)voidsetAllowNonUniqueOperationIds(Boolean value)voidsetAllowToJsonNulls(Boolean value)voidsetBaseModule(String value)voidsetCabalPackage(String value)voidsetCabalVersion(String value)voidsetConfigType(String value)voidsetCustomTestInstanceModule(String value)voidsetDateFormat(String value)voidsetDateTimeFormat(String value)voidsetDateTimeParseFormat(String value)voidsetGenerateEnums(Boolean value)voidsetGenerateFormUrlEncodedInstances(Boolean value)voidsetGenerateLenses(Boolean value)voidsetGenerateModelConstructors(Boolean value)voidsetInlineMimeTypes(Boolean value)voidsetModelDeriving(String value)voidsetQueryExtraUnreserved(String value)voidsetRequestType(String value)voidsetStrictFields(Boolean value)voidsetUseKatip(Boolean value)StringtoApiFilename(String name)Return the file name of the Api TestStringtoApiName(String name)Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is emptyStringtoDefaultValue(io.swagger.v3.oas.models.media.Schema p)Return the default value of the propertyStringtoEnumName(CodegenProperty var)Return the Enum name (e.g.StringtoEnumValue(String value, String datatype)Return the enum value in the language specified format e.g.StringtoEnumVarName(String value, String datatype)Return the sanitized variable name for enumStringtoInstantiationType(io.swagger.v3.oas.models.media.Schema p)Return the instantiation type of the property, especially for map and arrayStringtoModelFilename(String name)Return the capitalized file name of the modelStringtoModelName(String name)Converts the OpenAPI schema name to a model name suitable for the current code generator.StringtoOperationId(String operationId)Return the operation ID (method name)StringtoParamName(String name)Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.StringtoTypeName(String prefix, String name)StringtoVarName(String name)Return the variable name by removing invalid characters and proper escaping if it's a reserved word.StringtoVarName(String prefix, String name)voidupdateCodegenPropertyEnum(CodegenProperty var)Update codegen property's enum by adding "enumVars" (with name and value)voidupdateCodegenPropertyEnumValues(CodegenProperty var, String paramNameType)protected voidupdateDataTypeWithEnumForMap(CodegenProperty property)Update datatypeWithEnum for map containervoidupdateGlobalAdditionalProps()-
Methods inherited from class org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isAnyTypeSchema, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessModelProperty, postProcessParameter, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toMediaTypeSchemaName, toModelDocFilename, toModelImport, toModelImportMap, toModelTestFilename, toOneOfName, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateDataTypeWithEnumForArray, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, 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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessModelProperty, postProcessParameter, 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, testPackage, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelImportMap, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions
-
-
-
-
Field Detail
-
sourceFolder
protected String sourceFolder
-
defaultDateFormat
protected String defaultDateFormat
-
defaultCabalVersion
protected String defaultCabalVersion
-
modulePath
protected String modulePath
-
defaultQueryExtraUnreserved
protected String defaultQueryExtraUnreserved
-
useKatip
protected Boolean useKatip
-
allowNonUniqueOperationIds
protected Boolean allowNonUniqueOperationIds
-
genEnums
protected Boolean genEnums
-
PROP_ALLOW_FROMJSON_NULLS
public static final String PROP_ALLOW_FROMJSON_NULLS
- See Also:
- Constant Field Values
-
PROP_ALLOW_NONUNIQUE_OPERATION_IDS
public static final String PROP_ALLOW_NONUNIQUE_OPERATION_IDS
- See Also:
- Constant Field Values
-
PROP_ALLOW_TOJSON_NULLS
public static final String PROP_ALLOW_TOJSON_NULLS
- See Also:
- Constant Field Values
-
PROP_BASE_MODULE
public static final String PROP_BASE_MODULE
- See Also:
- Constant Field Values
-
PROP_CABAL_PACKAGE
public static final String PROP_CABAL_PACKAGE
- See Also:
- Constant Field Values
-
PROP_CABAL_VERSION
public static final String PROP_CABAL_VERSION
- See Also:
- Constant Field Values
-
PROP_CONFIG_TYPE
public static final String PROP_CONFIG_TYPE
- See Also:
- Constant Field Values
-
PROP_DATETIME_FORMAT
public static final String PROP_DATETIME_FORMAT
- See Also:
- Constant Field Values
-
PROP_DATETIME_PARSE_FORMAT
public static final String PROP_DATETIME_PARSE_FORMAT
- See Also:
- Constant Field Values
-
PROP_CUSTOM_TEST_INSTANCE_MODULE
public static final String PROP_CUSTOM_TEST_INSTANCE_MODULE
- See Also:
- Constant Field Values
-
PROP_DATE_FORMAT
public static final String PROP_DATE_FORMAT
- See Also:
- Constant Field Values
-
PROP_GENERATE_ENUMS
public static final String PROP_GENERATE_ENUMS
- See Also:
- Constant Field Values
-
PROP_GENERATE_FORM_URLENCODED_INSTANCES
public static final String PROP_GENERATE_FORM_URLENCODED_INSTANCES
- See Also:
- Constant Field Values
-
PROP_GENERATE_LENSES
public static final String PROP_GENERATE_LENSES
- See Also:
- Constant Field Values
-
PROP_GENERATE_MODEL_CONSTRUCTORS
public static final String PROP_GENERATE_MODEL_CONSTRUCTORS
- See Also:
- Constant Field Values
-
PROP_INLINE_MIME_TYPES
public static final String PROP_INLINE_MIME_TYPES
- See Also:
- Constant Field Values
-
PROP_MODEL_DERIVING
public static final String PROP_MODEL_DERIVING
- See Also:
- Constant Field Values
-
PROP_QUERY_EXTRA_UNRESERVED
public static final String PROP_QUERY_EXTRA_UNRESERVED
- See Also:
- Constant Field Values
-
PROP_REQUEST_TYPE
public static final String PROP_REQUEST_TYPE
- See Also:
- Constant Field Values
-
PROP_STRICT_FIELDS
public static final String PROP_STRICT_FIELDS
- See Also:
- Constant Field Values
-
PROP_USE_KATIP
public static final String PROP_USE_KATIP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getTag
public CodegenType getTag()
- Specified by:
getTagin interfaceCodegenConfig- Overrides:
getTagin classDefaultCodegen
-
getName
public String getName()
- Specified by:
getNamein interfaceCodegenConfig- Overrides:
getNamein classDefaultCodegen
-
getHelp
public String getHelp()
- Specified by:
getHelpin interfaceCodegenConfig- Overrides:
getHelpin classDefaultCodegen
-
setAllowNonUniqueOperationIds
public void setAllowNonUniqueOperationIds(Boolean value)
-
setAllowFromJsonNulls
public void setAllowFromJsonNulls(Boolean value)
-
setAllowToJsonNulls
public void setAllowToJsonNulls(Boolean value)
-
setGenerateModelConstructors
public void setGenerateModelConstructors(Boolean value)
-
setGenerateEnums
public void setGenerateEnums(Boolean value)
-
setGenerateFormUrlEncodedInstances
public void setGenerateFormUrlEncodedInstances(Boolean value)
-
setInlineMimeTypes
public void setInlineMimeTypes(Boolean value)
-
setGenerateLenses
public void setGenerateLenses(Boolean value)
-
setModelDeriving
public void setModelDeriving(String value)
-
setDateTimeFormat
public void setDateTimeFormat(String value)
-
setDateTimeParseFormat
public void setDateTimeParseFormat(String value)
-
setDateFormat
public void setDateFormat(String value)
-
setCabalPackage
public void setCabalPackage(String value)
-
setCabalVersion
public void setCabalVersion(String value)
-
setQueryExtraUnreserved
public void setQueryExtraUnreserved(String value)
-
setBaseModule
public void setBaseModule(String value)
-
setRequestType
public void setRequestType(String value)
-
setConfigType
public void setConfigType(String value)
-
setStrictFields
public void setStrictFields(Boolean value)
-
setUseKatip
public void setUseKatip(Boolean value)
-
setCustomTestInstanceModule
public void setCustomTestInstanceModule(String value)
-
processOpts
public void processOpts()
- Specified by:
processOptsin interfaceCodegenConfig- Overrides:
processOptsin classDefaultCodegen
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
- Specified by:
preprocessOpenAPIin interfaceCodegenConfig- Overrides:
preprocessOpenAPIin classDefaultCodegen
-
postProcessSupportingFileData
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
- Specified by:
postProcessSupportingFileDatain interfaceCodegenConfig- Overrides:
postProcessSupportingFileDatain classDefaultCodegen
-
getTypeDeclaration
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
Description copied from class:DefaultCodegenOutput the language-specific type declaration of the property.- Specified by:
getTypeDeclarationin interfaceCodegenConfig- Overrides:
getTypeDeclarationin classDefaultCodegen- Parameters:
p- property schema- Returns:
- a string presentation of the property type
-
getSchemaType
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
Description copied from class:DefaultCodegenreturns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type- Overrides:
getSchemaTypein classDefaultCodegen- Parameters:
p- property schema- Returns:
- string presentation of the type
-
toInstantiationType
public String toInstantiationType(io.swagger.v3.oas.models.media.Schema p)
Description copied from class:DefaultCodegenReturn the instantiation type of the property, especially for map and array- Overrides:
toInstantiationTypein classDefaultCodegen- Parameters:
p- property schema- Returns:
- string presentation of the instantiation type of the property
-
addOperationToGroup
public void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation op, Map<String,List<CodegenOperation>> operations)
Description copied from class:DefaultCodegenAdd operation to group- Specified by:
addOperationToGroupin interfaceCodegenConfig- Overrides:
addOperationToGroupin classDefaultCodegen- Parameters:
tag- name of the tagresourcePath- path of the resourceoperation- OAS Operation objectop- Codegen Operation objectoperations- map of Codegen operations
-
fromSecurity
public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemes)
Description copied from class:DefaultCodegenConvert map of OAS SecurityScheme objects to a list of Codegen Security objects- Specified by:
fromSecurityin interfaceCodegenConfig- Overrides:
fromSecurityin classDefaultCodegen- Parameters:
schemes- a map of OAS SecuritySchemeDefinition object- Returns:
- a list of Codegen Security objects
-
postProcessAllModels
public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)
- Specified by:
postProcessAllModelsin interfaceCodegenConfig- Overrides:
postProcessAllModelsin classDefaultCodegen
-
updateGlobalAdditionalProps
public void updateGlobalAdditionalProps()
-
postProcessOperationsWithModels
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
- Specified by:
postProcessOperationsWithModelsin interfaceCodegenConfig- Overrides:
postProcessOperationsWithModelsin classDefaultCodegen
-
fromModel
public CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema mod)
Description copied from class:DefaultCodegenConvert OAS Model object to Codegen Model object.- Specified by:
fromModelin interfaceCodegenConfig- Overrides:
fromModelin classDefaultCodegen- Parameters:
name- the name of the modelmod- OAS Model object- Returns:
- Codegen Model object
-
escapeReservedWord
public String escapeReservedWord(String name)
Description copied from class:DefaultCodegenReturn the escaped name of the reserved word- Specified by:
escapeReservedWordin interfaceCodegenConfig- Overrides:
escapeReservedWordin classDefaultCodegen- Parameters:
name- the name to be escaped- Returns:
- the escaped reserved word
throws Runtime exception as reserved word is not allowed (default behavior)
-
escapeQuotationMark
public String escapeQuotationMark(String input)
Description copied from class:DefaultCodegenEscape single and/or double quote to avoid code injection- Specified by:
escapeQuotationMarkin interfaceCodegenConfig- Overrides:
escapeQuotationMarkin classDefaultCodegen- Parameters:
input- String to be cleaned up- Returns:
- string with quotation mark removed or escaped
-
escapeUnsafeCharacters
public String escapeUnsafeCharacters(String input)
Description copied from class:DefaultCodegenoverride with any special text escaping logic to handle unsafe characters so as to avoid code injection- Specified by:
escapeUnsafeCharactersin interfaceCodegenConfig- Overrides:
escapeUnsafeCharactersin classDefaultCodegen- Parameters:
input- String to be cleaned up- Returns:
- string with unsafe characters removed or escaped
-
isDataTypeFile
public boolean isDataTypeFile(String dataType)
- Overrides:
isDataTypeFilein classDefaultCodegen
-
isDataTypeBinary
public boolean isDataTypeBinary(String dataType)
- Overrides:
isDataTypeBinaryin classDefaultCodegen
-
toVarName
public String toVarName(String name)
Description copied from class:DefaultCodegenReturn the variable name by removing invalid characters and proper escaping if it's a reserved word.- Overrides:
toVarNamein classDefaultCodegen- Parameters:
name- the variable name- Returns:
- the sanitized variable name
-
toParamName
public String toParamName(String name)
Description copied from class:DefaultCodegenReturn the parameter name by removing invalid characters and proper escaping if it's a reserved word.- Specified by:
toParamNamein interfaceCodegenConfig- Overrides:
toParamNamein classDefaultCodegen- Parameters:
name- Codegen property object- Returns:
- the sanitized parameter name
-
toModelName
public String toModelName(String name)
Description copied from class:DefaultCodegenConverts the OpenAPI schema name to a model name suitable for the current code generator. May be overridden for each programming language. In case the name belongs to the TypeSystem it won't be renamed.- Specified by:
toModelNamein interfaceCodegenConfig- Overrides:
toModelNamein classDefaultCodegen- Parameters:
name- the name of the model- Returns:
- capitalized model name
-
toModelFilename
public String toModelFilename(String name)
Description copied from class:DefaultCodegenReturn the capitalized file name of the model- Specified by:
toModelFilenamein interfaceCodegenConfig- Overrides:
toModelFilenamein classDefaultCodegen- Parameters:
name- the model name- Returns:
- the file name of the model
-
toApiName
public String toApiName(String name)
Description copied from class:DefaultCodegenOutput the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty- Specified by:
toApiNamein interfaceCodegenConfig- Overrides:
toApiNamein classDefaultCodegen- Parameters:
name- the name of the Api- Returns:
- capitalized Api name
-
toApiFilename
public String toApiFilename(String name)
Description copied from class:DefaultCodegenReturn the file name of the Api Test- Specified by:
toApiFilenamein interfaceCodegenConfig- Overrides:
toApiFilenamein classDefaultCodegen- Parameters:
name- the file name of the Api- Returns:
- the file name of the Api
-
apiFileFolder
public String apiFileFolder()
- Specified by:
apiFileFolderin interfaceCodegenConfig- Overrides:
apiFileFolderin classDefaultCodegen
-
toOperationId
public String toOperationId(String operationId)
Description copied from class:DefaultCodegenReturn the operation ID (method name)- Overrides:
toOperationIdin classDefaultCodegen- Parameters:
operationId- operation ID- Returns:
- the sanitized method name
-
toDefaultValue
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
Description copied from class:DefaultCodegenReturn the default value of the propertyThis method should be overridden in the generator to meet its requirement. Return null if you do NOT want a default value. Any non-null value will cause {{#defaultValue} check to pass.
- Overrides:
toDefaultValuein classDefaultCodegen- Parameters:
p- Property schema- Returns:
- string presentation of the default value of the property
-
postProcessModels
public ModelsMap postProcessModels(ModelsMap objs)
- Specified by:
postProcessModelsin interfaceCodegenConfig- Overrides:
postProcessModelsin classDefaultCodegen
-
postProcessModelsEnum
public ModelsMap postProcessModelsEnum(ModelsMap objs)
Description copied from class:DefaultCodegenpost process enum defined in model's properties- Overrides:
postProcessModelsEnumin classDefaultCodegen- Parameters:
objs- Map of models- Returns:
- maps of models with better enum support
-
updateDataTypeWithEnumForMap
protected void updateDataTypeWithEnumForMap(CodegenProperty property)
Description copied from class:DefaultCodegenUpdate datatypeWithEnum for map container- Overrides:
updateDataTypeWithEnumForMapin classDefaultCodegen- Parameters:
property- Codegen property
-
toEnumName
public String toEnumName(CodegenProperty var)
Description copied from class:DefaultCodegenReturn the Enum name (e.g. StatusEnum given 'status')- Overrides:
toEnumNamein classDefaultCodegen- Parameters:
var- Codegen property- Returns:
- the Enum name
-
updateCodegenPropertyEnum
public void updateCodegenPropertyEnum(CodegenProperty var)
Description copied from class:DefaultCodegenUpdate codegen property's enum by adding "enumVars" (with name and value)- Overrides:
updateCodegenPropertyEnumin classDefaultCodegen- Parameters:
var- list of CodegenProperty
-
updateCodegenPropertyEnumValues
public void updateCodegenPropertyEnumValues(CodegenProperty var, String paramNameType)
-
toEnumVarName
public String toEnumVarName(String value, String datatype)
Description copied from class:DefaultCodegenReturn the sanitized variable name for enum- Overrides:
toEnumVarNamein classDefaultCodegen- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized variable name for enum
-
toEnumValue
public String toEnumValue(String value, String datatype)
Description copied from class:DefaultCodegenReturn the enum value in the language specified format e.g. status becomes "status"- Overrides:
toEnumValuein classDefaultCodegen- Parameters:
value- enum variable namedatatype- data type- Returns:
- the sanitized value for enum
-
escapeText
public String escapeText(String input)
- Specified by:
escapeTextin interfaceCodegenConfig- Overrides:
escapeTextin classDefaultCodegen
-
postProcessFile
public void postProcessFile(File file, String fileType)
Description copied from class:DefaultCodegenPost-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"TODO: store these values in enum instead
- Specified by:
postProcessFilein interfaceCodegenConfig- Overrides:
postProcessFilein classDefaultCodegen- Parameters:
file- file to be processedfileType- file type
-
generatorLanguage
public GeneratorLanguage generatorLanguage()
- Specified by:
generatorLanguagein interfaceCodegenConfig- Overrides:
generatorLanguagein classDefaultCodegen
-
-