Package org.citrusframework.yaml

Annotation Interface SchemaProperty

@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface SchemaProperty
Schema property annotation, helps to generate Json schema for the full Citrus YAML DSL.

  • Element Details

    • kind

      SchemaProperty.Kind kind
      The property kind.
      Default:
      PROPERTY

    • group

      String group
      Schema group reference.
      Default:
      ""

    • module

      String module
      Citrus module information.
      Default:
      ""

    • name

      String name
      Name of the property
      Default:
      ""

    • title

      String title
      Title of the property
      Default:
      ""

    • description

      String description
      Description of the property
      Default:
      ""

    • format

      SchemaProperty.TypeFormat format
      Format for String properties
      Default:
      NONE

    • defaultValue

      String defaultValue
      Default value of the property
      Default:
      ""

    • multipleOf

      double multipleOf
      MultipleOf value for number properties
      Default:
      0.0

    • min

      double min
      Minimum value for number properties
      Default:
      4.9E-324

    • exclusiveMin

      boolean exclusiveMin
      Exclusive minimum value for number properties
      Default:
      false

    • max

      double max
      Maximum value for number properties
      Default:
      1.7976931348623157E308

    • exclusiveMax

      boolean exclusiveMax
      Exclusive maximum value for number properties
      Default:
      false

    • minLength

      int minLength
      Minimum length for String properties
      Default:
      0

    • maxLength

      int maxLength
      Maximum length for String properties
      Default:
      2147483647

    • pattern

      String pattern
      Pattern for String properties
      Default:
      ""

    • required

      boolean required
      Required properties
      Default:
      false

    • ignore

      boolean ignore
      Ignore field/ method during the process of generation of json schema
      Default:
      false

    • advanced

      boolean advanced
      Marks property as an advanced setting. Advanced settings may get displayed in a designer only on demand.
      Default:
      false

    • metadata

      SchemaProperty.MetaData[] metadata
      Additional meta data (key-value pairs) for properties
      Default:
      {}