One Of

The oneOf keyword can be used to combine multiple subschemas. The provided value must be valid against exactly one of the subschemas.

{
    "$id": "example",
    "type": "object",
    "properties": {
        "example": {
            "oneOf": [
                {
                    "type": "number",
                    "multipleOf": 5
                },
                {
                    "type": "number",
                    "multipleOf": 3
                }
            ]
        }
    }
}

Valid values are eg. 3, 5, 6, 9, 10, 12. Invalid values are eg. 1, 2, 4, 7, 8, 11 or any non numeric values.

Generated interface:

public function setExample(float $example): self;
public function getExample(): float;

Possible exception (if a string is provided):

Invalid value for example declined by composition constraint.
  Requires to match one composition element but matched 0 elements.
  - Composition element #1: Failed
    * Invalid type for example. Requires float, got string
  - Composition element #2: Failed
    * Invalid type for example. Requires float, got string

Possible exception (if eg. 15 is provided, which matches both subschemas):

Invalid value for example declined by composition constraint.
  Requires to match one composition element but matched 2 elements.
  - Composition element #1: Valid
  - Composition element #2: Valid

The thrown exception will be a PHPModelGenerator\Exception\ComposedValue\OneOfException which provides the following methods to get further error details:

// returns a two-dimensional array which contains all validation exceptions grouped by composition elements
public function getCompositionErrorCollection(): array
// get the amount of succeeded composition elements
public function getSucceededCompositionElements(): int
// get the name of the property which failed
public function getPropertyName(): string
// get the value provided to the property
public function getProvidedValue()

Hint

When combining multiple nested objects with an oneOf composition a merged property will be generated