feat: creates api endpoints specifications

restocking/src/main/scala/dev/atedeg/mdm/restocking/api/Handlers.scala

@@ -37,7 +37,7 @@ def productionStartedHandler[M[_]: Monad: LiftIO: CanRaise[String]](
     _ <- writeStockToDB(newStock.toDTO[StockDTO])
   yield ()
 
-private def readQuintalsFromDB[M[_]: Monad: LiftIO]: M[RemainingMilkDTO] = ???
-private def makeMilkOrder[M[_]: Monad: LiftIO](orderMilkDTO: OrderMilkDTO): M[Unit] = ???
-private def readStockFromDB[M[_]: Monad: LiftIO]: M[StockDTO] = ???
-private def writeStockToDB[M[_]: Monad: LiftIO](newStock: StockDTO): M[Unit] = ???
+private def readQuintalsFromDB[M[_]: Monad: LiftIO]: M[RemainingMilkDTO] = RemainingMilkDTO(10).pure
+private def makeMilkOrder[M[_]: Monad: LiftIO](orderMilkDTO: OrderMilkDTO): M[Unit] = ().pure
+private def readStockFromDB[M[_]: Monad: LiftIO]: M[StockDTO] = Map("Milk" -> 10.2).pure
+private def writeStockToDB[M[_]: Monad: LiftIO](newStock: StockDTO): M[Unit] = ().pure

restocking/src/main/scala/dev/atedeg/mdm/restocking/api/endpoints/Endpoints.scala

@@ -0,0 +1,28 @@
+package dev.atedeg.mdm.restocking.api.endpoints
+
+import cats.data.{ EitherT, ReaderT }
+import cats.effect.IO
+import io.circe.generic.auto.*
+import org.http4s.HttpRoutes
+import sttp.tapir.*
+import sttp.tapir.generic.auto.*
+import sttp.tapir.json.circe.jsonBody
+import sttp.tapir.server.http4s.Http4sServerInterpreter
+
+import dev.atedeg.mdm.restocking.api.{ remaningQuintalsOfMilkHandler, DBClient }
+import dev.atedeg.mdm.restocking.api.dto.RemainingMilkDTO
+import dev.atedeg.mdm.utils.monads.ServerAction
+
+object RemainingQuintalsOfMilkEndpoint:
+  private val handler: ServerAction[DBClient, String, RemainingMilkDTO] = remaningQuintalsOfMilkHandler
+
+  @SuppressWarnings(Array("org.wartremover.warts.Any"))
+  val remainingQuintalsOfMilkEndpoint: PublicEndpoint[Unit, String, RemainingMilkDTO, Any] =
+    endpoint.get
+      .in("remaining-quintals-of-milk")
+      .out(jsonBody[RemainingMilkDTO].description("The quintals of milk remaining in stock"))
+      .errorOut(stringBody)
+
+  val remainingQuintalsOfMilkRoute: HttpRoutes[IO] = Http4sServerInterpreter[IO]().toRoutes(
+    remainingQuintalsOfMilkEndpoint.serverLogic(_ => handler.value.run(DBClient())),
+  )