softwaremill / softwaremill/tapir

[BUG] Json, CodecFormat.Json in endpoint type results in oneOf in yaml

Open
#1,718 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.5k
Forks
468
Avg merge
5h 37m
Merged PRs (30d)
34

Description

Tapir version: 0.20.0-M3

Code to reproduce:

 val personEndpoint = endpoint.get
      .in(header[String]("Test").description("Test token").deprecated())
      .out(webSocketBody[String, CodecFormat.TextPlain, Json, CodecFormat.Json](AkkaStreams))

    val yaml = AsyncAPIInterpreter().toAsyncAPI(personEndpoint, "Header flags", "1.0").toYaml

should result in output yaml containing following lines .

'oneOf:':
      payload: {}
      contentType: application/json

Unfortunately such behavior is not correct.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the provided personEndpoint reproduction, especially webSocketBodyString, CodecFormat.TextPlain, Json, CodecFormat.Json, and trace AsyncAPIInterpreter().toAsyncAPI(...).toYaml. Compare the generated YAML with the expected payload and ensure the JSON codec does not produce an incorrect oneOf structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.