Package com.asyncapi.schemas.openapi.v3._0_0.properties

Class Discriminator

java.lang.Object

com.asyncapi.schemas.openapi.v3._0_0.properties.Discriminator

public class Discriminator
extends Object

When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation.

The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.

When using the discriminator, inline schemas will not be considered.

The discriminator attribute is legal only when using one of the composite keywords oneOf, anyOf, allOf.

Version:

3.0.0

Author:

Pavel Bodiachevskii

See Also:

• Discriminator Object
• Discriminator

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable Map<String,String>	mapping	An object to hold mappings between payload values and schema names or references.
@NotNull String	propertyName	REQUIRED.

Constructor Summary

Constructors

Constructor	Description
Discriminator()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

propertyName

@NotNull
@JsonPropertyDescription("The name of the property in the payload that will hold the discriminator value.")
public @NotNull String propertyName

REQUIRED.

The name of the property in the payload that will hold the discriminator value.

mapping

@Nullable
@JsonPropertyDescription("An object to hold mappings between payload values and schema names or references.")
public @Nullable Map<String,String> mapping

An object to hold mappings between payload values and schema names or references.

Constructor Details

Discriminator

public Discriminator()