Package com.github.victools.jsonschema.generator

Interface CustomPropertyDefinitionProvider<M extends MemberScope<?,?>>

Type Parameters:
M - either field or method for which a custom definition may be provided
All Superinterfaces:
StatefulConfig
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface CustomPropertyDefinitionProvider<M extends MemberScope<?,?>> extends StatefulConfig
Provider of non-standard JSON schema definitions.

  • Method Details

    • provideCustomSchemaDefinition

      CustomPropertyDefinition provideCustomSchemaDefinition(M scope, SchemaGenerationContext context)
      Look-up the non-standard JSON schema definition for a given property. If it returns null, the next definition provider is applied.
      Parameters:
      scope - targeted scope to provide custom definition for
      context - generation context allowing to let the standard generation take over nested parts of the custom definition
      Returns:
      non-standard JSON schema definition (may be null)