automatic propagation of schema name as schema title

Closes softwaremill#3447
ghik · Mar 12, 2024 · 960291b · 960291b
1 parent bd97fe2
commit 960291b
Show file tree

Hide file tree

Showing 89 changed files with 181 additions and 6 deletions.
diff --git a/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/SchemasForEndpoints.scala b/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/SchemasForEndpoints.scala
@@ -27,7 +27,7 @@ class SchemasForEndpoints(
     val keysToIds: Map[SchemaKey, SchemaId] = calculateUniqueIds(keyedCombinedSchemas.map(_._1), (key: SchemaKey) => schemaName(key.name))
 
     val toSchemaReference = new ToSchemaReference(keysToIds, keyedCombinedSchemas.toMap)
-    val tschemaToASchema = new TSchemaToASchema(toSchemaReference, markOptionsAsNullable)
+    val tschemaToASchema = new TSchemaToASchema(schemaName, toSchemaReference, markOptionsAsNullable)
 
     val keysToSchemas: ListMap[SchemaKey, ASchema] =
       keyedCombinedSchemas.map(td => (td._1, tschemaToASchema(td._2, allowReference = false))).toListMap

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
@@ -1,7 +1,7 @@
 package sttp.tapir.docs.apispec.schema
 
 import sttp.apispec.{Schema => ASchema, _}
-import sttp.tapir.Schema.Title
+import sttp.tapir.Schema.{SName, Title}
 import sttp.tapir.Validator.EncodeToRaw
 import sttp.tapir.docs.apispec.DocsExtensionAttribute.RichSchema
 import sttp.tapir.docs.apispec.schema.TSchemaToASchema.{tDefaultToADefault, tExampleToAExample}
@@ -10,7 +10,11 @@ import sttp.tapir.internal._
 import sttp.tapir.{Codec, Validator, Schema => TSchema, SchemaType => TSchemaType}
 
 /** Converts a tapir schema to an OpenAPI/AsyncAPI schema, using `toSchemaReference` to resolve references. */
-private[docs] class TSchemaToASchema(toSchemaReference: ToSchemaReference, markOptionsAsNullable: Boolean) {
+private[docs] class TSchemaToASchema(
+    fallbackSchemaTitle: SName => String,
+    toSchemaReference: ToSchemaReference,
+    markOptionsAsNullable: Boolean
+) {
 
   def apply[T](codec: Codec[T, _, _]): ASchema = apply(codec.schema, allowReference = true)
 
@@ -93,8 +97,11 @@ private[docs] class TSchemaToASchema(toSchemaReference: ToSchemaReference, markO
       .toListMap
   }
 
-  private def addTitle(oschema: ASchema, tschema: TSchema[_]): ASchema =
-    oschema.copy(title = tschema.attributes.get(Title.Attribute).map(_.value))
+  private def addTitle(oschema: ASchema, tschema: TSchema[_]): ASchema = {
+    val fromAttr = tschema.attributes.get(Title.Attribute).map(_.value)
+    def fallback = tschema.name.map(fallbackSchemaTitle)
+    oschema.copy(title = fromAttr orElse fallback)
+  }
 
   private def addMetadata(oschema: ASchema, tschema: TSchema[_]): ASchema = {
     oschema.copy(

diff --git a/.../apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TapirSchemaToJsonSchema.scala b/.../apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TapirSchemaToJsonSchema.scala
@@ -19,7 +19,7 @@ object TapirSchemaToJsonSchema {
 
     val keysToIds = calculateUniqueIds(keyedSchemas.map(_._1), (key: SchemaKey) => schemaName(key.name))
     val toSchemaReference = new ToSchemaReference(keysToIds, keyedSchemas.toMap, refRoot = "#/$defs/")
-    val tschemaToASchema = new TSchemaToASchema(toSchemaReference, markOptionsAsNullable)
+    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)) }
 

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct.yml
@@ -16,17 +16,20 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator.yml
@@ -16,6 +16,7 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person'
@@ -25,13 +26,15 @@ components:
           john: '#/components/schemas/Person'
           sml: '#/components/schemas/Organization'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_nested.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_nested.yml
@@ -16,6 +16,7 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person'
@@ -25,20 +26,23 @@ components:
           john: '#/components/schemas/Person'
           sml: '#/components/schemas/Organization'
     NestedEntity:
+      title: NestedEntity
       required:
         - entity
       type: object
       properties:
         entity:
           $ref: '#/components/schemas/Entity'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/...pi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_with_enum_circe.yml b/...pi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_with_enum_circe.yml
@@ -16,13 +16,15 @@ paths:
 components:
   schemas:
     Shape:
+      title: Shape
       oneOf:
         - $ref: '#/components/schemas/Square'
       discriminator:
         propertyName: shapeType
         mapping:
           Square: '#/components/schemas/Square'
     Square:
+      title: Square
       required:
         - color
         - shapeType

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_independent.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_independent.yml
@@ -54,6 +54,7 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person1'
@@ -63,6 +64,7 @@ components:
           organization: '#/components/schemas/Organization'
           person: '#/components/schemas/Person1'
     Organization:
+      title: Organization
       required:
         - name
         - kind
@@ -73,6 +75,7 @@ components:
         kind:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age
@@ -84,6 +87,7 @@ components:
           type: integer
           format: int32
     Person1:
+      title: Person
       required:
         - name
         - age

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_nested.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_nested.yml
@@ -16,24 +16,28 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person'
     NestedEntity:
+      title: NestedEntity
       required:
         - entity
       type: object
       properties:
         entity:
           $ref: '#/components/schemas/Entity'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_wrapped.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_wrapped.yml
@@ -30,6 +30,7 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - required:
             - Organization
@@ -44,13 +45,15 @@ components:
             Person:
               $ref: '#/components/schemas/Person'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_generic_coproduct.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_generic_coproduct.yml
@@ -42,12 +42,15 @@ paths:
 components:
   schemas:
     GenericEntity_Int:
+      title: GenericEntity_Int
       oneOf:
         - $ref: '#/components/schemas/GenericPerson_Int'
     GenericEntity_String:
+      title: GenericEntity_String
       oneOf:
         - $ref: '#/components/schemas/GenericPerson_String'
     GenericPerson_Int:
+      title: GenericPerson_Int
       required:
         - data
       type: object
@@ -56,6 +59,7 @@ components:
           type: integer
           format: int32
     GenericPerson_String:
+      title: GenericPerson_String
       required:
         - data
       type: object

diff --git a/docs/openapi-docs/src/test/resources/coproduct/expected_recursive_coproducts.yml b/docs/openapi-docs/src/test/resources/coproduct/expected_recursive_coproducts.yml
@@ -24,17 +24,20 @@ paths:
 components:
   schemas:
     Clause:
+      title: Clause
       oneOf:
         - $ref: '#/components/schemas/Expression'
         - $ref: '#/components/schemas/Not'
     Expression:
+      title: Expression
       required:
         - v
       type: object
       properties:
         v:
           type: string
     Not:
+      title: Not
       required:
         - not
       type: object

diff --git a/.../openapi-docs/src/test/resources/coproduct/expected_unfolded_coproduct_unfolded_array.yml b/.../openapi-docs/src/test/resources/coproduct/expected_unfolded_coproduct_unfolded_array.yml
@@ -18,17 +18,20 @@ paths:
 components:
   schemas:
     Entity:
+      title: Entity
       oneOf:
         - $ref: '#/components/schemas/Organization'
         - $ref: '#/components/schemas/Person'
     Organization:
+      title: Organization
       required:
         - name
       type: object
       properties:
         name:
           type: string
     Person:
+      title: Person
       required:
         - name
         - age

diff --git a/...cs/src/test/resources/decode_failure_output/expected_json_response_defined_in_options.yml b/...cs/src/test/resources/decode_failure_output/expected_json_response_defined_in_options.yml
@@ -26,6 +26,7 @@ paths:
 components:
   schemas:
     Fail:
+      title: Fail
       required:
         - msg
       type: object

diff --git a/docs/openapi-docs/src/test/resources/enum/expected_enum_collections.yml b/docs/openapi-docs/src/test/resources/enum/expected_enum_collections.yml
@@ -16,11 +16,13 @@ paths:
 components:
   schemas:
     CornerStyle:
+      title: CornerStyle
       type: string
       enum:
         - rounded
         - straight
     Square:
+      title: Square
       type: object
       properties:
         cornerStyle:
@@ -30,6 +32,7 @@ components:
           items:
             $ref: '#/components/schemas/Tag'
     Tag:
+      title: Tag
       type: string
       enum:
         - tag1

diff --git a/docs/openapi-docs/src/test/resources/enum/expected_enum_in_delimited_query.yml b/docs/openapi-docs/src/test/resources/enum/expected_enum_in_delimited_query.yml
@@ -27,6 +27,7 @@ paths:
 components:
   schemas:
     CornerStyle:
+      title: CornerStyle
       type: string
       enum:
         - rounded

diff --git a/docs/openapi-docs/src/test/resources/enum/expected_enum_in_delimited_query_with_default.yml b/docs/openapi-docs/src/test/resources/enum/expected_enum_in_delimited_query_with_default.yml
@@ -33,6 +33,7 @@ paths:
 components:
   schemas:
     CornerStyle:
+      title: CornerStyle
       type: string
       enum:
       - rounded

diff --git a/...t/resources/enum/expected_enumeratum_enum_adding_default_when_encoded_value_specified.yml b/...t/resources/enum/expected_enumeratum_enum_adding_default_when_encoded_value_specified.yml
@@ -28,17 +28,20 @@ paths:
 components:
   schemas:
     FruitQueryWithEncoded:
+      title: FruitQueryWithEncoded
       type: object
       properties:
         fruitType:
           $ref: '#/components/schemas/FruitType'
           default: PEAR
     FruitType:
+      title: FruitType
       type: string
       enum:
         - APPLE
         - PEAR
     FruitWithEnum:
+      title: FruitWithEnum
       required:
         - fruit
         - amount

diff --git a/docs/openapi-docs/src/test/resources/enum/expected_enumeratum_enum_collection_component.yml b/docs/openapi-docs/src/test/resources/enum/expected_enumeratum_enum_collection_component.yml
@@ -16,12 +16,14 @@ paths:
 components:
   schemas:
     CountryCode:
+      title: CountryCode
       type: string
       enum:
         - PL
         - BE
         - LU
     CountryCollection:
+      title: CountryCollection
       required:
         - countryCode
       type: object