Package io.micronaut.openapi.annotation

Annotation Interface OpenAPIGroupInfo

@Repeatable(OpenAPIGroupInfos.class) @Retention(SOURCE) @Documented @Target({PACKAGE,TYPE,ANNOTATION_TYPE}) public @interface OpenAPIGroupInfo
With this annotation, you can specify the OpenAPIDefinition description that will be inserted into a specific swagger file, only for this group. Thus, you can make different descriptions for different groups.
Since:
4.10.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    io.swagger.v3.oas.annotations.OpenAPIDefinition
    info
     
    String[]
    names
     
    io.swagger.v3.oas.annotations.security.SecurityScheme[]
    securitySchemes
     
    String[]
    value
     

  • Element Details

    • value

      @AliasFor(member="names") String[] value
      Returns:
      The names of the OpenAPI groups.
      Default:
      {}

    • names

      @AliasFor(member="value") String[] names
      Returns:
      The names of the OpenAPI groups.
      Default:
      {}

    • info

      io.swagger.v3.oas.annotations.OpenAPIDefinition info
      Returns:
      OpenAPI object describing information about group.
      Default:
      @io.swagger.v3.oas.annotations.OpenAPIDefinition

    • securitySchemes

      io.swagger.v3.oas.annotations.security.SecurityScheme[] securitySchemes
      Returns:
      Security schemes for OpenAPI group.
      Since:
      6.6.0
      Default:
      {}