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

Class Swagger2SchemaDefinitionNamingStrategy

java.lang.Object
com.github.victools.jsonschema.module.swagger2.Swagger2SchemaDefinitionNamingStrategy
All Implemented Interfaces:
com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy, com.github.victools.jsonschema.generator.StatefulConfig
public class Swagger2SchemaDefinitionNamingStrategy extends Object implements com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy
Naming strategy for the keys in the definitions/$defs of the produced schema, based on @Schema(name = ...).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Swagger2SchemaDefinitionNamingStrategy(com.github.victools.jsonschema.generator.naming.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<com.github.victools.jsonschema.generator.impl.DefinitionKey,String> subschemasWithDuplicateNames, com.github.victools.jsonschema.generator.SchemaGenerationContext generationContext)
     
    String
    adjustNullableName(com.github.victools.jsonschema.generator.impl.DefinitionKey key, String definitionName, com.github.victools.jsonschema.generator.SchemaGenerationContext generationContext)
     
    String
    getDefinitionNameForKey(com.github.victools.jsonschema.generator.impl.DefinitionKey key, com.github.victools.jsonschema.generator.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 Details

    • Swagger2SchemaDefinitionNamingStrategy

      public Swagger2SchemaDefinitionNamingStrategy(com.github.victools.jsonschema.generator.naming.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 Details

    • getDefinitionNameForKey

      public String getDefinitionNameForKey(com.github.victools.jsonschema.generator.impl.DefinitionKey key, com.github.victools.jsonschema.generator.SchemaGenerationContext generationContext)
      Specified by:
      getDefinitionNameForKey in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy

    • adjustDuplicateNames

      public void adjustDuplicateNames(Map<com.github.victools.jsonschema.generator.impl.DefinitionKey,String> subschemasWithDuplicateNames, com.github.victools.jsonschema.generator.SchemaGenerationContext generationContext)
      Specified by:
      adjustDuplicateNames in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy

    • adjustNullableName

      public String adjustNullableName(com.github.victools.jsonschema.generator.impl.DefinitionKey key, String definitionName, com.github.victools.jsonschema.generator.SchemaGenerationContext generationContext)
      Specified by:
      adjustNullableName in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy