Package io.domainlifecycles.swagger.v3

Class OpenAPITemporalTypeExtension

java.lang.Object

io.domainlifecycles.swagger.v3.OpenAPITemporalTypeExtension

public class OpenAPITemporalTypeExtension
extends Object

This class provides additional temporal type support, which reflects the Jackson default behaviour. The extension adds Open API schemata for several additional temporal types:

- LocalTime - OffsetTime - Year - YearMonth - MonthDay

the default Springdoc behaviour currently (v.1.6.9) doesn't support those types.

The temporal type extension works as well as for domain object types as for all other classes which require Open API support by SpringDoc.

Constructor Summary

Constructors

Constructor	Description
OpenAPITemporalTypeExtension()

Method Summary

Modifier and Type	Method	Description
static void	extendOpenAPISchemaForTemporalTypes(io.swagger.v3.oas.models.OpenAPI openAPI)	Central entry point for the Open API extension with additional temporal type schemata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenAPITemporalTypeExtension

public OpenAPITemporalTypeExtension()

Method Details

extendOpenAPISchemaForTemporalTypes

public static void extendOpenAPISchemaForTemporalTypes(io.swagger.v3.oas.models.OpenAPI openAPI)

Central entry point for the Open API extension with additional temporal type schemata.

Parameters:

openAPI - OpenAPI instance to be extended