search

shardbox / shardbox-web

Webapp for shardbox.org
https://www.shardbox.org/
MIT License
10 stars 3 forks source link

Having an API ? #4

Open waghanza opened 4 years ago

waghanza commented 4 years ago

Hi @straight-shoota,

It could be useful to have any API (GraphQL or else) that allow an external application to query the shardbox database.

For exemple, I wish to implement a bot that create a PR on a crystal project, in order to keep the dependencies up-to-date.

Regards,

straight-shoota commented 4 years ago

Thanks for bringing that up! There are plans, but didn't get around implementing it yet. I figured, until someone asks, there's no need to prioritize it 😄

My knowledge of GraphQL is pretty limited and it's more complex to implement, so I'd suggest a relatively simple REST API first. PRs for GraphQL endpoint would be welcome, but it's not a primary focus.

Regarding the API, I suppose there should be an endpoint to export the entire database, but also to query information about individual shards, their releases, dependencies and dependents.

Are you aware of shards outdated command? It's only available in master and the 0.9 release candidates. It might also be useful for your bot, I don't know.

waghanza commented 4 years ago

Thanks for bringing that up! There are plans, but didn't get around implementing it yet. I figured, until someone asks, there's no need to prioritize it

I can implement it :stuck_out_tongue:, but I will be more confortable with REST than GraphQL

Main idea is to have a way to query database : do this shard has a new version ?

Are you aware of shards outdated command? It's only available in master and the 0.9 release candidates. It might also be useful for your bot, I don't know.

Yes, however the shards outdated command require a manual action. The idea to have an API is that a bot could do the same thing for us :stuck_out_tongue:

I think it could be great for crystal adoption. Moreover, in the project I have, their is plenty of languages. I prefer not to do crystal outdated, bundle audit --update, npm auto-update .... :heart: