Annotation Interface ApiDocComponent

@Retention(RUNTIME) @Target({}) @Documented public @interface ApiDocComponent
Adds a raw OpenAPI component to generated API documentation.

The path is relative to the OpenAPI components object, for example responses.error or securitySchemes.basicAuth. The value must be a JSON object or scalar that can be placed at that path.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    json
    JSON value for the component.
    String
    path
    Component path relative to components, separated by dots.

  • Element Details

    • path

      String path
      Component path relative to components, separated by dots.

    • json

      String json
      JSON value for the component.