io.micronaut.openapi.annotation

Annotation Type OpenAPIGroupInfo

@Repeatable(value=OpenAPIGroupInfos.class)
 @Retention(value=SOURCE)
 @Documented
 @Target(value={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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
io.swagger.v3.oas.annotations.OpenAPIDefinition	info

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	names
java.lang.String[]	value

Element Detail

info

public abstract io.swagger.v3.oas.annotations.OpenAPIDefinition info

Returns:

OpenAPI object describing information about group.

value

@AliasFor(member="names")
public abstract java.lang.String[] value

Returns:

The names of the OpenAPi groups.

Default:

{}

names

@AliasFor(member="value")
public abstract java.lang.String[] names

Returns:

The names of the OpenAPi groups.

Default:

{}