Package com.github.victools.jsonschema.module.swagger2

Class Swagger2SchemaDefinitionNamingStrategy

java.lang.Object

com.github.victools.jsonschema.module.swagger2.Swagger2SchemaDefinitionNamingStrategy

All Implemented Interfaces:

SchemaDefinitionNamingStrategy, StatefulConfig

public class Swagger2SchemaDefinitionNamingStrategy
extends Object
implements SchemaDefinitionNamingStrategy

Naming strategy for the keys in the definitions/$defs of the produced schema, based on @Schema(name = ...).

Constructor Summary

Constructors

Constructor	Description
Swagger2SchemaDefinitionNamingStrategy(SchemaDefinitionNamingStrategy baseStrategy)	Constructor expecting a base strategy to be applied if there is no Schema annotation with a specific name being specified.

Method Summary

Modifier and Type	Method	Description
void	adjustDuplicateNames(Map<DefinitionKey,String> subschemasWithDuplicateNames, SchemaGenerationContext generationContext)
String	adjustNullableName(DefinitionKey key, String definitionName, SchemaGenerationContext generationContext)
String	getDefinitionNameForKey(DefinitionKey key, SchemaGenerationContext generationContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.victools.jsonschema.generator.StatefulConfig

resetAfterSchemaGenerationFinished

Constructor Detail

Swagger2SchemaDefinitionNamingStrategy

public Swagger2SchemaDefinitionNamingStrategy(SchemaDefinitionNamingStrategy baseStrategy)

Constructor expecting a base strategy to be applied if there is no Schema annotation with a specific name being specified.

Parameters:

baseStrategy - fall-back strategy to be applied

Method Detail

getDefinitionNameForKey

public String getDefinitionNameForKey(DefinitionKey key,
                                      SchemaGenerationContext generationContext)

Specified by:

getDefinitionNameForKey in interface SchemaDefinitionNamingStrategy

adjustDuplicateNames

public void adjustDuplicateNames(Map<DefinitionKey,String> subschemasWithDuplicateNames,
                                 SchemaGenerationContext generationContext)

Specified by:

adjustDuplicateNames in interface SchemaDefinitionNamingStrategy

adjustNullableName

public String adjustNullableName(DefinitionKey key,
                                 String definitionName,
                                 SchemaGenerationContext generationContext)

Specified by:

adjustNullableName in interface SchemaDefinitionNamingStrategy