Documentation

OneOfInterface

Interface implemented by models generated from a `oneOf` schema.

A oneOf schema is not represented by a value object; instead a value is one of the composed member types. Classes implementing this interface only carry the metadata that ObjectSerializer::deserialize() needs to resolve the concrete member type.

Tags
author

OpenAPI Generator team

Table of Contents

Methods

getOneOfDiscriminator()  : string|null
Name of the discriminator property used to resolve the concrete member type, or null when the schema has no discriminator.
getOneOfDiscriminatorMappings()  : array<string, string>
Mapping of discriminator values to the concrete member type. Empty when the schema has no discriminator.
getOneOfTypes()  : array<string|int, string>
List of the types a value of this `oneOf` schema may be. Each entry uses the same notation as the values of {@see ModelInterface::openAPITypes()}.

Methods

getOneOfDiscriminator()

Name of the discriminator property used to resolve the concrete member type, or null when the schema has no discriminator.

public static getOneOfDiscriminator() : string|null
Return values
string|null

getOneOfDiscriminatorMappings()

Mapping of discriminator values to the concrete member type. Empty when the schema has no discriminator.

public static getOneOfDiscriminatorMappings() : array<string, string>
Return values
array<string, string>

getOneOfTypes()

List of the types a value of this `oneOf` schema may be. Each entry uses the same notation as the values of {@see ModelInterface::openAPITypes()}.

public static getOneOfTypes() : array<string|int, string>
Return values
array<string|int, string>
On this page

Search results