io.muserver.openapi

Class DiscriminatorObjectBuilder

java.lang.Object

io.muserver.openapi.DiscriminatorObjectBuilder

public class DiscriminatorObjectBuilder
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.

Constructor Summary

Constructors

Constructor and Description
DiscriminatorObjectBuilder()

Method Summary

Modifier and Type	Method and Description
DiscriminatorObject	build()
static DiscriminatorObjectBuilder	discriminatorObject() Creates a builder for a DiscriminatorObject
DiscriminatorObjectBuilder	withMapping(Map<String,String> mapping)
DiscriminatorObjectBuilder	withPropertyName(String propertyName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscriminatorObjectBuilder

public DiscriminatorObjectBuilder()

Method Detail

withPropertyName

public DiscriminatorObjectBuilder withPropertyName(String propertyName)

Parameters:

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

Returns:

The current builder

withMapping

public DiscriminatorObjectBuilder withMapping(Map<String,String> mapping)

Parameters:

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

Returns:

The current builder

build

public DiscriminatorObject build()

discriminatorObject

public static DiscriminatorObjectBuilder discriminatorObject()

Creates a builder for a DiscriminatorObject

Returns:

A new builder