Align search API with search page #656
Conversation
adpi2
force-pushed
the
fix-search-api
branch
from
5c315a0 to
ab6f480
Compare
| cli: Boolean | ||
| )(project: Project): SearchApi.Project = { | ||
| val artifacts = if (cli) project.cliArtifacts.toList else project.artifacts | ||
| SearchApi.Project( |
There was a problem hiding this comment.
Can we also include defaultArtifact since search API under the hood redirects to it anyway.
There was a problem hiding this comment.
I have added the defaultArtifact field coming from the Project data class. You can try it here.
This field is not set automatically, it is set manually by the library maintainer. So it can be empty or completely nonsense.
| @@ -10,29 +10,33 @@ package object routes { | |||
| ( | |||
| "q" ? "*", | |||
| "page".as[Int] ? 1, | |||
| "total".as[Int] ? SearchParams.resultsPerPage, | |||
There was a problem hiding this comment.
Could we also include information about available pages? Currently one needs to call next page until the response is empty (but this is probably not in the scope of this PR).
There was a problem hiding this comment.
I have added the currentPage and pageTotal fields: https://index-dev.scala-lang.org/api/search?q=*&scalaVersions=scala3&sort=stars&total=20&page=2
adpi2
force-pushed
the
fix-search-api
branch
from
3f84d64 to
4d564b0
Compare
| @@ -91,7 +104,8 @@ class SearchApi( | |||
| val routes: Route = | |||
| pathPrefix("api") { | |||
| cors() { | |||
| path("search") { | |||
| // deprecated endpoint replaced by api/search endpoint | |||
| path("search-old") { | |||
There was a problem hiding this comment.
Should we instead keep this one and introduce a new endpoint api/search/v2, to not break existing users?
This PR deprecates the current
api/searchendpoint by renaming itapi/search-old.Then it introduces a new
api/searchendpoint whose query inputs, behavior and response are similar to thesearchpage enpoint.This new API can be tested on the dev environment: https://index-dev.scala-lang.org
Example:
https://index-dev.scala-lang.org/api/search?q=*&scalaVersions=scala3&sort=stars&total=20