Package org.apache.juneau.marshall.oapi

Annotation Interface OpenApi

@Documented @Target({TYPE,FIELD,METHOD}) @Retention(RUNTIME) @Inherited public @interface OpenApi
Annotation that can be applied to classes, fields, and methods to tweak how they are handled by OpenApiSerializer and OpenApiParser.

Can be used in the following locations:

  • Marshalled classes/methods/fields.
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    description
    Optional description for the exposed API.

  • Element Details

    • description

      String[] description
      Optional description for the exposed API.
      Returns:
      The annotation value.
      Since:
      9.2.0
      Default:
      {}