dataframe-openapi-generator/org.jetbrains.kotlinx.dataframe.io

Package-level declarations

Types

internal object DefaultReadOpenApiMethod : AbstractDefaultReadMethod

Used to add readJson and convertToMyMarker functions to the generated interfaces. Makes sure convertDataRowsWithOpenApi is always used in conversions.

FieldTypeResult

internal sealed interface FieldTypeResult

Either FieldTypeResult.CannotFindRefMarker or FieldTypeResult.FieldType.

GetRefMarker

internal fun interface GetRefMarker

Represents a query to find a Marker with certain name. Produces a MarkerResult.

IsObject

internal interface IsObject

MarkerResult

internal sealed interface MarkerResult

Either MarkerResult.CannotFindRefMarker or MarkerResult.OpenApiMarker containing an org.jetbrains.kotlinx.dataframe.io.OpenApiMarker.

OpenApi

class OpenApi : SupportedCodeGenerationFormat

Allows for OpenApi type schemas to be converted to DataSchema interfaces.

OpenApiIntegerFormat

internal enum class OpenApiIntegerFormat : Enum<OpenApiIntegerFormat>

https://swagger.io/docs/specification/data-models/data-types/#numbers

OpenApiMarker

internal sealed class OpenApiMarker : Marker, IsObject

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.

OpenApiNumberFormat

internal enum class OpenApiNumberFormat : Enum<OpenApiNumberFormat>

https://swagger.io/docs/specification/data-models/data-types/#numbers

OpenApiStringFormat

internal enum class OpenApiStringFormat : Enum<OpenApiStringFormat>

https://swagger.io/docs/specification/data-models/data-types/#string

OpenApiType

internal sealed class OpenApiType(val name: String?) : IsObject

Represents all types supported by OpenApi with functions to create a FieldType from each.

OpenApiTypeResult

internal sealed interface OpenApiTypeResult

Either an OpenApiTypeResult.UsingRef, OpenApiTypeResult.CannotFindRefMarker, OpenApiTypeResult.OpenApiType, or OpenApiTypeResult.Enum.

ProduceAdditionalMarker

internal fun interface ProduceAdditionalMarker

Represents a call to produce an additional Marker from inside a schema component. Not all objects or enums are named, so this is used to create and produce a name for them.

RetrievableMarker

internal fun interface RetrievableMarker

Represents a call to toMarker that can be repeated until it returns a MarkerResult.OpenApiMarker.

Functions

generatedEnumFieldOf

internal fun generatedEnumFieldOf(fieldName: ValidFieldName, columnName: String): GeneratedField

Helper function to create a GeneratedField for enums.

generatedFieldOf

internal fun generatedFieldOf(fieldName: ValidFieldName, columnName: String, overrides: Boolean, fieldType: FieldType): GeneratedField

Helper function to create a GeneratedField without GeneratedField.columnSchema.

getMarker

internal fun AdditionalProperty.Companion.getMarker(typeArguments: List<String>): Marker

isOpenApi

fun isOpenApi(url: URL): Boolean

fun isOpenApi(path: Path): Boolean

fun isOpenApi(path: String): Boolean

isOpenApiStr

fun isOpenApiStr(text: String): Boolean

Needs to have any type schemas to convert.

produceNewEnum

internal fun produceNewEnum(name: String, topInterfaceName: ValidFieldName, values: List<String>, nullable: Boolean, produceAdditionalMarker: ProduceAdditionalMarker): OpenApiMarker.Enum

Small helper function to produce a new enum Marker.

readOpenApi

fun readOpenApi(uri: String, name: String, auth: List<AuthorizationValue>? = null, options: ParseOptions? = null, extensionProperties: Boolean, generateHelperCompanionObject: Boolean, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC): Code

Parse and read OpenApi specification to DataSchema interfaces.

readOpenApiAsString

fun readOpenApiAsString(openApiAsString: String, name: String, auth: List<AuthorizationValue>? = null, options: ParseOptions? = null, extensionProperties: Boolean, generateHelperCompanionObject: Boolean, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC): Code

Parse and read OpenApi specification to DataSchema interfaces.

refersToNullableMarker

internal fun FieldType.refersToNullableMarker(getRefMarker: GetRefMarker, topInterfaceName: ValidFieldName): Boolean

Returns whether this FieldType refers to a Marker that is itself nullable (such as a nullable enum, whose nullability is defined by the type and cannot be removed by making a property required). Returns false for primitives and non-nullable markers.

snakeToUpperCamelCase

internal fun String.snakeToUpperCamelCase(): String

toNullable

internal fun String.toNullable(): String

withoutTopInterfaceName

internal fun String.withoutTopInterfaceName(topInterfaceName: ValidFieldName): String

withTopInterfaceName

internal fun String.withTopInterfaceName(topInterfaceName: ValidFieldName): String