http4k-api-jsonschema/org.http4k.contract.jsonschema.v3

Package-level declarations

Types

class AutoJsonToJsonSchema<NODE : Any>(json: AutoMarshallingJson<NODE>, fieldRetrieval: FieldRetrieval = FieldRetrieval.compose( SimpleLookup( metadataRetrievalStrategy = PrimitivesFieldMetadataRetrievalStrategy ) ), modelNamer: SchemaModelNamer = Simple, refLocationPrefix: String = "components/schemas", metadataRetrieval: MetadataRetrieval = MetadataRetrieval.compose(SimpleMetadataLookup(emptyMap()))) : JsonSchemaCreator<Any, NODE>

Data4kFieldMetadataRetrievalStrategy

object Data4kFieldMetadataRetrievalStrategy : FieldMetadataRetrievalStrategy

Data4kJsonSchemaMeta

sealed interface Data4kJsonSchemaMeta

Values of the json schema metadata

Field

data class Field(val value: Any, val isNullable: Boolean, val metadata: FieldMetadata)

FieldHolder

data class FieldHolder(val value: Any)

FieldMetadata

data class FieldMetadata(val extra: Map<String, Any?> = emptyMap())

FieldMetadataRetrievalStrategy

fun interface FieldMetadataRetrievalStrategy : Function2<Any, String, FieldMetadata>

FieldRetrieval

fun interface FieldRetrieval : Function2<Any, String, Field>

JacksonFieldMetadataRetrievalStrategy

object JacksonFieldMetadataRetrievalStrategy : FieldMetadataRetrievalStrategy

JacksonJsonNamingAnnotated

class JacksonJsonNamingAnnotated(json: ConfigurableJackson = Jackson) : FieldRetrieval

JacksonJsonPropertyAnnotated

object JacksonJsonPropertyAnnotated : FieldRetrieval

JsonToJsonSchema

class JsonToJsonSchema<NODE>(json: Json<NODE>, refLocationPrefix: String = "components/schemas") : JsonSchemaCreator<NODE, NODE>

KondorJsonSchemaCreator

class KondorJsonSchemaCreator(json: KondorJson, refLocationPrefix: String = "components/schema") : JsonSchemaCreator<Any, JsonNode>

MapKey

data class MapKey(val keyAsString: Any)

MetadataRetrieval

fun interface MetadataRetrieval : Function1<Any, FieldMetadata>

NoFieldFound

class NoFieldFound(name: String, target: Any, cause: Throwable? = null) : RuntimeException

NoOpFieldMetadataRetrievalStrategy

class NoOpFieldMetadataRetrievalStrategy : FieldMetadataRetrievalStrategy

PrimitivesFieldMetadataRetrievalStrategy

object PrimitivesFieldMetadataRetrievalStrategy : FieldMetadataRetrievalStrategy

SchemaModelNamer

fun interface SchemaModelNamer : Function1<Any, String>

SchemaModelNamerChain

fun interface SchemaModelNamerChain : Function1<Any, String?>

SimpleLookup

class SimpleLookup(renamingStrategy: (String) -> String = { it }, metadataRetrievalStrategy: FieldMetadataRetrievalStrategy = NoOpFieldMetadataRetrievalStrategy()) : FieldRetrieval

SimpleMetadataLookup

class SimpleMetadataLookup(typeToMetadata: Map<KType, FieldMetadata>) : MetadataRetrieval

Values4kFieldMetadataRetrievalStrategy

object Values4kFieldMetadataRetrievalStrategy : FieldMetadataRetrievalStrategy

Set format values for OpenApi descriptions for fields of this type

Properties

value

val ParamMeta.value: String

Functions

then

fun FieldMetadataRetrievalStrategy.then(that: FieldMetadataRetrievalStrategy): FieldMetadataRetrievalStrategy

Combine Strategies, with the first taking precedence

fun SchemaModelNamerChain.then(next: SchemaModelNamer): SchemaModelNamer

fun SchemaModelNamerChain.then(next: SchemaModelNamerChain): SchemaModelNamerChain