From b033abf2c478836fe38652f09f76a038f8b432a5 Mon Sep 17 00:00:00 2001 From: Roman Janusz Date: Tue, 12 Mar 2024 15:37:47 +0100 Subject: [PATCH] added a comment about adding fallback schema title --- .../scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala b/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala index 9ce9821ab6..2f01c06c92 100644 --- a/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala +++ b/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala @@ -99,6 +99,8 @@ private[docs] class TSchemaToASchema( private def addTitle(oschema: ASchema, tschema: TSchema[_]): ASchema = { val fromAttr = tschema.attributes.get(Title.Attribute).map(_.value) + // The primary motivation for using schema name as fallback title is to improve Swagger UX with + // `oneOf` schemas in OpenAPI 3.1. See https://github.com/softwaremill/tapir/issues/3447 for details. def fallback = tschema.name.map(fallbackSchemaTitle) oschema.copy(title = fromAttr orElse fallback) }