io.micronaut.openapi.annotation

Annotation Type OpenAPIDecorator

@Retention(value=RUNTIME)
 @Documented
 @Target(value={TYPE,METHOD})
public @interface OpenAPIDecorator

The annotation can be used to add suffix and prefix for operationIds. For example, when you have 2 controllers with same operations, but use generics:

 {@code @OpenAPIDecorator(opIdPrefix = "cats-", opIdSuffix = "-suffix")

Since:

4.5.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	addAlways
java.lang.String	opIdPrefix
java.lang.String	opIdSuffix
java.lang.String	value

Element Detail

value

public abstract java.lang.String value

Returns:

Prefix for operation ids.

Default:

""

opIdPrefix

@AliasFor(member="value")
public abstract java.lang.String opIdPrefix

Returns:

Prefix for operation ids.

Default:

""

opIdSuffix

public abstract java.lang.String opIdSuffix

Returns:

Suffix for operation ids.

Default:

""

addAlways

public abstract boolean addAlways

Returns:

is this flag false, prefixes and suffixes will not be added to operationId if operationId is set explicitly in the Operation annotation

Default:

true