io.swagger.v3.oas.annotations.media

Annotation Type PatternProperty

@Target(value={FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Repeatable(value=PatternProperties.class)
public @interface PatternProperty

The annotation may be used in OpenAPI 3.1 schemas / JSON Schema.

Since:

2.1.8

See Also:

JSON Schema section 10.3.2.2, Schema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ArraySchema	array The schema of the array to validate against for properties matching the regex.
String	regex The regex.
Schema	schema The schema to validate against for properties matching the regex.

Element Detail

regex

public abstract String regex

The regex.

Returns:

the regex

Default:

""

schema

public abstract Schema schema

The schema to validate against for properties matching the regex.

Returns:

the schema

Default:

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

array

public abstract ArraySchema array

The schema of the array to validate against for properties matching the regex.

Returns:

the schema of the array

Default:

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