Package io.swagger.v3.oas.annotations.media

Annotation Type DependentSchema

@Target({FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Inherited
@Repeatable(DependentSchemas.class)
public @interface DependentSchema

The annotation may be used to define dependent schemas for an Object Schema

Since:

2.2.12 / OpenAPI 3.1

See Also:

Schema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ArraySchema	array	The value (ArraySchema) of the dependent schema map item.
String	name	The name.
Schema	schema	The value (Schema) of the dependent schema map item.

Element Detail

name

String name

The name.

Returns:

the key of the dependent schema map item

Default:

""

schema

Schema schema

The value (Schema) of the dependent schema map item. Alternative to `array()`. Applied when the schema is not of type "array". Use `array()` when schema is of type "array"

Returns:

the schema

Default:

@io.swagger.v3.oas.annotations.media.Schema

array

ArraySchema array

The value (ArraySchema) of the dependent schema map item. Alternative to `schema()`. Applied when the schema is of type "array". Use `schema()` when schema is not of type "array"

Returns:

the value of the array schema

Default:

@io.swagger.v3.oas.annotations.media.ArraySchema