softwaremill / softwaremill/tapir
OpenAPI schema for union types is missing the discriminator level.
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.5k
- Forks
- 468
- Avg merge
- 5h 37m
- Merged PRs (30d)
- 34
Description
Repo with code: https://github.com/kamilkloch/tapir-union-types-schema
sealed trait Fruit
object Fruit {
case class Apple(color: String) extends Fruit
case class Potato(weight: Double) extends Fruit
private implicit val config: Configuration = Configuration.default
implicit val fruitCodec: io.circe.Codec[Fruit] = deriveConfiguredCodec
}
Generated OpenApi YAML is incorrect - it is missing the discriminant level. An Apple (from Fruit trait perspective) is of shape
{
"Apple" : {
"color": "string"
}
}
, and not
{
"color": "string"
}
Generated OpenApi YAML:
openapi: 3.1.0
info:
title: linguistic-nightingale
version: 1.0.0
paths:
/fruit:
post:
operationId: postFruit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Fruit'
required: true
responses:
'200':
description: ''
'400':
description: 'Invalid value for: body'
content:
text/plain:
schema:
type: string
components:
schemas:
Apple:
required:
- color
type: object
properties:
color:
type: string
Fruit:
oneOf:
- $ref: '#/components/schemas/Apple'
- $ref: '#/components/schemas/Potato'
Potato:
required:
- weight
type: object
properties:
weight:
type: number
format: double
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked tapir-union-types-schema reproduction and inspect the OpenAPI schema generation path for the Scala sealed-trait union. Compare the generated YAML with the reported Apple and Potato shapes; done means the Fruit schema represents each variant with its discriminator level while preserving the variant fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, scala
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100