Why LocalDateTime codec is actually OffsetDateTime in UTC?

mon4ter · August 2, 2024, 5:43am

softwaremill/tapir/blob/master/core/src/main/scala/sttp/tapir/Codec.scala#L239


      
            .mapDecode { l =>
              try {
                try {
                  Value(LocalDateTime.parse(l))
                } catch {
                  case _: DateTimeParseException => Value(OffsetDateTime.parse(l).toLocalDateTime)
                }
              } catch {
                case e: Exception => Error(l, e)
              }
            }(h => OffsetDateTime.of(h, ZoneOffset.UTC).toString)
            .schema(Schema.schemaForLocalDateTime)
          
          implicit val uri: PlainCodec[Uri] =
            string
              .mapDecode(raw => Uri.parse(raw).fold(e => DecodeResult.Error(raw, new IllegalArgumentException(e)), DecodeResult.Value(_)))(
                _.toString()
              )
              .schema(Schema.schemaForUri)
          
          def parsedString[T: Schema](parse: String => T): Codec[String, T, TextPlain] =

Why it’s shadily converts LocalDateTime to OffsetDateTime, so that adds Z suffix? Isn’t it supposed to be string.map(LocalDateTime.parse(_))(DateTimeFormatter.ISO_LOCAL_DATE_TIME.format).schema(Schema.schemaForLocalDateTime)?
I understand it’d break compatibility, but what’s the logic here?

adamw · August 5, 2024, 10:54am

There’s a comment on the test case that explains it:

// Because there is no separate standard for local date time, we encode it WITH timezone set to "Z"
// https://swagger.io/docs/specification/data-models/data-types/#string

Doesn’t mean it’s the best choice, though

Topic		Replies	Views
Changes to multipart codec in > 0.20.x tapir	6	240	November 24, 2023
Special characters in the XML response not represented correctly tapir	3	401	January 4, 2023
Embedding the custom body model validation as a given Codec? tapir	2	7	August 16, 2024
How to define custom Mutipart codec? tapir	1	148	January 5, 2024
Unit Testing with Scala 3 - STTP/Tapir/ZIO General	2	497	June 7, 2023

Why LocalDateTime codec is actually OffsetDateTime in UTC?

Related topics