Package com.github.victools.jsonschema.generator

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

Type Parameters:

M - type of the reference/context to modify

All Superinterfaces:

InstanceAttributeOverrideV2<M>, StatefulConfig

@Deprecated
public interface InstanceAttributeOverride<M extends MemberScope<?,?>>
extends InstanceAttributeOverrideV2<M>

Deprecated.

use InstanceAttributeOverrideV2 instead

Entry point for customising a JSON Schema being generated for a certain kind of reference/context.

Method Summary

Modifier and Type	Method	Description
void	overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode, M member)	Deprecated. Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
default void	overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode, M member, SchemaGenerationContext context)	Deprecated. 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 Detail

overrideInstanceAttributes

void overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode,
                                M member)

Deprecated.

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:

jsonSchemaAttributesNode - node to modify

member - reference/context to which the collected attributes in the JSON Schema node are referring

overrideInstanceAttributes

default void overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode,
                                        M member,
                                        SchemaGenerationContext context)

Deprecated.

Description copied from interface: InstanceAttributeOverrideV2

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

Specified by:

overrideInstanceAttributes in interface InstanceAttributeOverrideV2<M extends MemberScope<?,?>>

Parameters:

jsonSchemaAttributesNode - node to modify

member - reference/context to which the collected attributes in the JSON Schema node are referring

context - generation context