Package dev.relism.flash.ext.openapi

Annotation Interface Schema

@Retention(RUNTIME) @Target({TYPE,FIELD,METHOD}) public @interface Schema
Minimal OpenAPI schema metadata for model classes and properties.

  • Element Details

    • name

      String name
      Default:
      ""

    • title

      String title
      Default:
      ""

    • description

      String description
      Default:
      ""

    • format

      String format
      Default:
      ""

    • example

      String example
      Default:
      ""

    • enumeration

      String[] enumeration
      Default:
      {}

    • nullable

      boolean nullable
      Default:
      false

    • required

      boolean required
      Default:
      false

    • deprecated

      boolean deprecated
      Default:
      false

    • hidden

      boolean hidden
      Default:
      false