Derive Macro Union

#[derive(Union)]
{
    // Attributes available to this derive:
    #[oai]
}

Define an OpenAPI discriminator object.

Macro parameters

Attribute	Description	Type	Optional
discriminator_name	The name of the property in the payload that will hold the discriminator value.	string	Y
one_of	Validates the value against exactly one of the subschemas	bool	Y
external_docs	Specify a external resource for extended documentation	string	Y
rename_all	Rename all the mapping name according to the given case convention. The possible values are “lowercase”, “UPPERCASE”, “PascalCase”, “camelCase”, “snake_case”, “SCREAMING_SNAKE_CASE”, “kebab-case”, “SCREAMING-KEBAB-CASE”.	string	Y

Item parameters

Attribute	Description	Type	Optional
mapping	Rename the payload value. (Default is the object name)	string	Y

Example with discriminator

use poem_openapi::{Object, Union};

#[derive(Object, Debug, PartialEq)]
struct A {
    v1: i32,
    v2: String,
}

#[derive(Object, Debug, PartialEq)]
struct B {
    v3: f32,
}

#[derive(Union, Debug, PartialEq)]
#[oai(discriminator_name = "type")]
enum MyObj {
    A(A),
    B(B),
}

Example without discriminator

use poem_openapi::{Object, Union};

#[derive(Object, Debug, PartialEq)]
struct A {
    v1: i32,
    v2: String,
}

#[derive(Union, Debug, PartialEq)]
enum MyObj {
    A(A),
    B(bool),
    C(String),
}