busymachines.pureharm.internals.rest.PureharmTapirSchemas.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pureharm-rest-http4s-tapir_2.12 Show documentation
pureharm-rest-http4s-tapir
The newest version!
/** Copyright (c) 2017-2019 BusyMachines
  *
  * See company homepage at: https://www.busymachines.com/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
package busymachines.pureharm.internals.rest

import busymachines.pureharm.anomaly.{AnomalyBase, SeqStringWrapper}
import sttp.tapir

/** @author Lorand Szakacs, https://github.com/lorandszakacs
  * @since 14 Jul 2020
  */
object PureharmTapirSchemas {

  private val idFN       = tapir.FieldName("id")
  private val messageFN  = tapir.FieldName("message")
  private val messagesFN = tapir.FieldName("messages")
  private val paramsFN   = tapir.FieldName("parameters")

  val tapirSchemaAnomalies: tapir.Schema[Throwable] = {
    import cats.data.NonEmptyChain
    import cats.implicits._
    val seqOrString: tapir.Schema[SeqStringWrapper] = tapir.Schema(
      tapir.SchemaType.SCoproduct(
        tapir.SchemaType.SObjectInfo("string or array of strings"),
        List(
          tapir.Schema.schemaForString,
          tapir.Schema.schemaForArray[String],
        ),
        None,
      )
    )

    //using Chain because adding things with symbolic operators to an Iterable is... is...
    val baseSchema: NonEmptyChain[(tapir.FieldName, sttp.tapir.Schema[_])] = NonEmptyChain(
      idFN      -> tapir.Schema.schemaForString,
      messageFN -> tapir.Schema.schemaForString,
      paramsFN  -> tapir.Schema.schemaForOption(
        tapir.Schema.schemaForMap[SeqStringWrapper](seqOrString)
      ),
    )

    val schemaAnomalyBase: tapir.Schema[AnomalyBase] = tapir.Schema(
      tapir.SchemaType.SProduct(
        tapir.SchemaType.SObjectInfo("io.circe.JsonObject"),
        baseSchema.toIterable,
      )
    )
    tapir.Schema(
      tapir.SchemaType.SProduct(
        tapir.SchemaType.SObjectInfo("io.circe.JsonObject"),
        baseSchema
          .append(messagesFN -> tapir.Schema.schemaForOption[AnomalyBase](schemaAnomalyBase))
          .toIterable,
      )
    )
  }

}