sttp.tapir.docs.apispec.schema.TapirSchemaToJsonSchema.scala Maven / Gradle / Ivy
package sttp.tapir.docs.apispec.schema
import sttp.apispec.{Schema => ASchema}
import sttp.tapir.internal.IterableToListMap
import sttp.tapir.{Schema => TSchema}
import scala.collection.immutable.ListMap
/** Renders json schema from tapir schema.
*
* Note [[MetaSchemaDraft04]] is accepted for compatibility, but the [[sttp.apispec.Schema]] produced always follows
* [[MetaSchemaDraft202012]].
*/
object TapirSchemaToJsonSchema {
def apply(
schema: TSchema[_],
markOptionsAsNullable: Boolean,
metaSchema: MetaSchema = MetaSchemaDraft202012,
schemaName: TSchema.SName => String = defaultSchemaName
): ASchema = {
val asKeyedSchemas = ToKeyedSchemas(schema).drop(1)
val keyedSchemas = ToKeyedSchemas.uniqueCombined(asKeyedSchemas)
val keysToIds = calculateUniqueIds(keyedSchemas.map(_._1), (key: SchemaKey) => schemaName(key.name))
val toSchemaReference = new ToSchemaReference(keysToIds, keyedSchemas.toMap, refRoot = "#/$defs/")
val tschemaToASchema = new TSchemaToASchema(schemaName, toSchemaReference, markOptionsAsNullable)
val keysToSchemas = keyedSchemas.map(td => (td._1, tschemaToASchema(td._2, allowReference = false))).toListMap
val schemaIds = keysToSchemas.map { case (k, v) => k -> ((keysToIds(k), v)) }
val defsList = schemaIds.values.toListMap
val rootApiSpecSchemaOrRef: ASchema = tschemaToASchema(schema, allowReference = false)
rootApiSpecSchemaOrRef.copy(
`$schema` = Some(metaSchema.schemaId),
`$defs` = if (defsList.nonEmpty) Some(defsList) else None
)
}
// binary compatibility shim
private[docs] def apply(
schema: TSchema[_],
markOptionsAsNullable: Boolean,
addTitleToDefs: Boolean,
metaSchema: MetaSchema,
schemaName: TSchema.SName => String
): ASchema = apply(schema, markOptionsAsNullable, metaSchema, schemaName)
}