Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework the Scaladex API #1345

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Rework the Scaladex API #1345

merged 1 commit into from
Jun 13, 2024

Conversation

adpi2
Copy link
Member

@adpi2 adpi2 commented Feb 28, 2024

Introduces 3 endpoints:

  • GET /api/projects to get the lists of all projects, except the ones that are moved or deleted on Github.
  • GET /api/projects/<org>/<repo>/artifacts to get the lists of artifacts of a given project.
  • GET /api/artifacts/<groupid>/<artifactid>/<version> to get some info about an artifact (language, platform, licenses, release date etc).

The old GET /api/artifacts endpoint is removed because it was unsafe (OOM).

The language and platform filters are not yet implemented.

There is no pagination and I don't plan to add it in the near future. All responses of the new API should be reasonably small.

This PR is deployed on https://index-dev.scala-lang.org/ for testing. Some example requests are:

The API is documented here.

`GET  /api/projects` to get the lists of all project references, except the ones that are moved or deleted on Github.
`GET /api/projects/<org>/<repo>/artifacts` to get the lists of artifact refs of a project.
`GET /api/artifacts/<groupid>/<artifactid>/<version>` to get some info about an artifact (language, platform, licenses, release date etc).

There are no filter anymore. Later we can (re-)introduce the `language` and `platform` filters.
There is no pagination and I don't plan on working on it.
@adpi2 adpi2 merged commit e6162c2 into scalacenter:main Jun 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant