OpenApiMarker

Represents the type of Markers that we can use for code generation. This includes OpenApiMarker.Enum, OpenApiMarker.Interface (and OpenApiMarker.AdditionalPropertyInterface), OpenApiMarker.TypeAlias, and OpenApiMarker.MarkerAlias. It's a bit more flexible than Marker and ensures the right arguments are given for the right type of Marker.

Types

class AdditionalPropertyInterface(nullable: Boolean, val valueType: FieldType, name: String, topInterfaceName: ValidFieldName, additionalPropertyPaths: List<JsonPath>, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker.Interface

Special type of Interface that inherits AdditionalProperty. Also generates different read-methods in DefaultReadOpenApiMethod including automatic conversion to AdditionalProperty.

class Enum(nullable: Boolean, fields: List<GeneratedField>, name: String, topInterfaceName: ValidFieldName, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker

A Marker that will be used to generate an enum.

open class Interface(nullable: Boolean, fields: List<GeneratedField>, superMarkers: List<Marker>, name: String, topInterfaceName: ValidFieldName, val additionalPropertyPaths: List<JsonPath>, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker

A Marker that will be used to generate an interface.

class MarkerAlias(superMarker: OpenApiMarker, topInterfaceName: ValidFieldName, nullable: Boolean, name: String, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = false) : OpenApiMarker

A Marker that will be used to generate a type alias that points at another Marker.

class TypeAlias(nullable: Boolean, name: String, topInterfaceName: ValidFieldName, val superMarkerName: String, val additionalPropertyPaths: List<JsonPath>, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = false) : OpenApiMarker

A Marker that will be used to generate a type alias that points at a primitive.