Package com.github.victools.jsonschema.generator

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

  • Type Parameters:
    M - type of the reference/context to modify
    public interface InstanceAttributeOverride<M extends MemberScope<?,​?>>
    Entry point for customising a JSON Schema being generated for a certain kind of reference/context.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void overrideInstanceAttributes​(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode, M member)
      Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.

    • Method Detail

      • overrideInstanceAttributes

        void overrideInstanceAttributes​(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode,
                                M member)
        Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
        E.g. ""description"", ""minimum"", ""exclusiveMaximum""
        Parameters:
        jsonSchemaAttributesNode - node to modify
        member - reference/context to which the collected attributes in the JSON Schema node are referring