io.swagger.v3.oas.annotations.media

Annotation Type DiscriminatorMapping

@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface DiscriminatorMapping

The annotation may be used in Schema.discriminatorMapping() to define an optional mapping definition in scenarios involving composition / inheritance where the value of the discriminator field does not match the schema name or implicit mapping is not possible.

Use Schema.discriminatorProperty() to define a discriminator property.

See Also:

Discriminator (OpenAPI specification), Schema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	schema The schema that is being mapped to a property value
String	value The property value that will be mapped to a Schema

Element Detail

value

public abstract String value

The property value that will be mapped to a Schema

Returns:

the property value

Default:

""

schema

public abstract Class<?> schema

The schema that is being mapped to a property value

Returns:

the Schema reference

Default:

java.lang.Void.class