Annotation Interface OpenAPIGroup

@Repeatable(OpenAPIGroups.class) @Retention(SOURCE) @Documented @Target({PACKAGE,TYPE,METHOD}) public @interface OpenAPIGroup
With this annotation, you can specify one or more groups that this endpoint will be included in, as well as specify groups from which this endpoint should be excluded. Also, you can set specific endpoint extensions for each group
Since:
4.10.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    exclude
     
    io.swagger.v3.oas.annotations.extensions.Extension[]
    extensions
    The list of optional extensions only for these groups.
    String[]
    names
    Alias for 'value' member.
    String[]
    value
     

  • Element Details

    • value

      String[] value
      Returns:
      The names of the OpenAPI groups.
      Default:
      {}

    • names

      String[] names
      Alias for 'value' member.
      Returns:
      The names of the OpenAPI groups.
      Default:
      {}

    • exclude

      String[] exclude
      Returns:
      The names of the OpenAPI groups to exclude endpoints from.
      Default:
      {}

    • extensions

      io.swagger.v3.oas.annotations.extensions.Extension[] extensions
      The list of optional extensions only for these groups.
      Returns:
      an optional array of extensions
      Since:
      6.7.0
      Default:
      {}