Return results as an object

SwissDataScienceCenter · Feb 28, 2024 · b8d7e9f · b8d7e9f
1 parent 824d284
commit b8d7e9f
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 3 deletions.
diff --git a/modules/search-api/src/main/scala/io/renku/search/api/data/PageDef.scala b/modules/search-api/src/main/scala/io/renku/search/api/data/PageDef.scala
@@ -21,6 +21,7 @@ package io.renku.search.api.data
 import io.bullet.borer.Encoder
 import io.bullet.borer.derivation.MapBasedCodecs
 import io.bullet.borer.Decoder
+import sttp.tapir.Schema
 
 final case class PageDef(
     limit: Int,
@@ -40,3 +41,4 @@ object PageDef:
 
   given Encoder[PageDef] = MapBasedCodecs.deriveEncoder
   given Decoder[PageDef] = MapBasedCodecs.deriveDecoder
+  given Schema[PageDef] = Schema.derived
diff --git a/modules/search-api/src/main/scala/io/renku/search/api/data/PageWithTotals.scala b/modules/search-api/src/main/scala/io/renku/search/api/data/PageWithTotals.scala
@@ -18,6 +18,11 @@
 
 package io.renku.search.api.data
 
+import io.bullet.borer.{Decoder, Encoder}
+import io.bullet.borer.NullOptions.given
+import io.bullet.borer.derivation.MapBasedCodecs
+import sttp.tapir.Schema
+
 final case class PageWithTotals(
     page: PageDef,
     prevPage: Option[Int],
@@ -27,6 +32,10 @@ final case class PageWithTotals(
 )
 
 object PageWithTotals:
+  given Encoder[PageWithTotals] = MapBasedCodecs.deriveEncoder
+  given Decoder[PageWithTotals] = MapBasedCodecs.deriveDecoder
+  given Schema[PageWithTotals] = Schema.derived
+
   def apply(page: PageDef, totalResults: Long, hasMore: Boolean): PageWithTotals =
     PageWithTotals(
       page,

diff --git a/modules/search-api/src/main/scala/io/renku/search/api/data/SearchResult.scala b/modules/search-api/src/main/scala/io/renku/search/api/data/SearchResult.scala
@@ -18,7 +18,17 @@
 
 package io.renku.search.api.data
 
+import io.bullet.borer.derivation.MapBasedCodecs
+import io.bullet.borer.Encoder
+import io.bullet.borer.Decoder
+import sttp.tapir.Schema
+
 final case class SearchResult(
     items: Seq[SearchEntity],
     pagingInfo: PageWithTotals
 )
+
+object SearchResult:
+  given Encoder[SearchResult] = MapBasedCodecs.deriveEncoder
+  given Decoder[SearchResult] = MapBasedCodecs.deriveDecoder
+  given Schema[SearchResult] = Schema.derived
diff --git a/modules/search-api/src/main/scala/io/renku/search/api/tapir/Params.scala b/modules/search-api/src/main/scala/io/renku/search/api/tapir/Params.scala
@@ -65,5 +65,5 @@ object Params extends TapirCodecs with TapirBorerJson {
     borerJsonBody[Seq[SearchEntity]]
 
   val searchResult: EndpointOutput[SearchResult] =
-    searchItems.and(pagingInfo).mapTo[SearchResult]
+    borerJsonBody[SearchResult].and(pagingInfo).map(_._1)(r => (r, r.pagingInfo))
 }
diff --git a/modules/search-api/src/main/scala/io/renku/search/api/tapir/TapirCodecs.scala b/modules/search-api/src/main/scala/io/renku/search/api/tapir/TapirCodecs.scala
@@ -27,5 +27,4 @@ trait TapirCodecs:
     Codec.string.mapEither(Query.parse(_))(_.render)
 
   given Schema[Query] = Schema.anyObject[Query]
-  given Schema[PageDef] = Schema.derived
   given Schema[QueryInput] = Schema.derived
diff --git a/nix/openapi-doc.nix b/nix/openapi-doc.nix
@@ -20,7 +20,7 @@
         <script>
          window.onload = () => {
              window.ui = SwaggerUIBundle({
-                 url: 'http://localhost:8080/search/spec.json',
+                 url: 'http://localhost:8080/apiv2/search/spec.json',
                  dom_id: '#swagger-ui',
                  presets: [
                      SwaggerUIBundle.presets.apis,