Annotation Interface BelongsTo


@Retention(RUNTIME) @Target(TYPE) @Documented public @interface BelongsTo
Provides the means to associate a Servlet with a particular plugin API.

Note that this implies that all PathTemplates declared by the Servlet will be accessible relative to the plugin API basePath().

Author:
cdivilly
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Indicates the API to which this endpoint is bound
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Provides the path to an Open API resource that describes this resource
  • Element Details

    • value

      String value
      Indicates the API to which this endpoint is bound
      Returns:
      The name of the API
    • describedBy

      String describedBy
      Provides the path to an Open API resource that describes this resource
      Returns:
      path relative to API basePath(), of the Open API resource that describes this resource
      Default:
      ""