Package com.github.victools.jsonschema.generator

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

Type Parameters:
M - type of the reference/context to modify
All Superinterfaces:
StatefulConfig
All Known Subinterfaces:
InstanceAttributeOverride<M>
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 InstanceAttributeOverrideV2<M extends MemberScope<?,?>> extends StatefulConfig
Entry point for customising the JSON Schema attributes being collected for a property.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    overrideInstanceAttributes(tools.jackson.databind.node.ObjectNode collectedMemberAttributes, M member, SchemaGenerationContext context)
    Add/remove attributes on the given JSON Schema node - this is specifically intended for attributes relating to a particular instance.

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

    resetAfterSchemaGenerationFinished

  • Method Details

    • overrideInstanceAttributes

      void overrideInstanceAttributes(tools.jackson.databind.node.ObjectNode collectedMemberAttributes, M member, SchemaGenerationContext context)
      Add/remove attributes on the given JSON Schema node - this is specifically intended for attributes relating to a particular instance.
      E.g. SchemaKeyword.TAG_DESCRIPTION, SchemaKeyword.TAG_MINIMUM, SchemaKeyword.TAG_MAXIMUM_EXCLUSIVE
      Parameters:
      collectedMemberAttributes - node to modify
      member - reference/context to which the collected attributes in the JSON Schema node are referring
      context - generation context