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

Return all results in single API call #365

Open
jayrdi opened this issue Oct 11, 2018 · 14 comments
Open

Return all results in single API call #365

jayrdi opened this issue Oct 11, 2018 · 14 comments
Assignees
Labels
API Concerns the bio.tools API. high priority We get to these once "critical priority" issues are done. search / sort / filter Concerns bio.tools search box, or content sorting & filtering.

Comments

@jayrdi
Copy link

jayrdi commented Oct 11, 2018

Hi, sorry if this is not the right place for this as it's not an issue as such. I only have today to get this sorted though as I am moving on from this role.

Anyway, I am trying to list all tools associated with RD-Connect within the WordPress site for RD-Connect but it only pulls 10 items at a time.

It's difficult to implement pagination with the theme we are using and so I am hoping there is an endpoint parameter that will allow me to pull all results in a single page?

Thank you for your help!

@joncison joncison added search / sort / filter Concerns bio.tools search box, or content sorting & filtering. API Concerns the bio.tools API. high priority We get to these once "critical priority" issues are done. labels Oct 11, 2018
@joncison
Copy link
Member

I'm afraid there isn't currently. More flexibility has been requested a lot (e.g. #111, #325, #76, #310) - an improvement has to be made soon, but it can't be done today.

cc @piotrgithub1 @hansioan - the requests around this are building up. Let's discuss / act during the next dev call?

@jayrdi
Copy link
Author

jayrdi commented Oct 11, 2018

Okay, thanks for your help. For now then, I will set it up as if that functionality exists, and then when it does I can just add the endpoint parameter to list all items to the API request and the web page should display properly..

Thanks for getting back to me so quickly!

@joncison
Copy link
Member

no probs ... please cc your replacement on this thread so they can nudge us / keep up-to-date with developments

@jayrdi
Copy link
Author

jayrdi commented Oct 11, 2018

cc @lmatalonga

@albangaignard
Copy link
Contributor

albangaignard commented Oct 11, 2018 via email

@joncison
Copy link
Member

@albangaignard it'd be nice to put this in a repo, so others can see it. Lot's of people have to do this, so having a worked example would be very helpful.

We could create https://github.com/bio-tools/utilities or some such for it (and similar things) - what do you think?

@albangaignard
Copy link
Contributor

albangaignard commented Oct 15, 2018

Hi all, I just commited a notebook to show how to crawl page per page.

capture d ecran 2018-10-15 a 11 28 53

@joncison, if you think its usefull we could create a dedicated repo to share kind of "recipes".

@joncison
Copy link
Member

nice !

I just created:
https://github.com/bio-tools/utilities

Please upload it there, and add a note in the table in the README.md to give the file name and
a short description of what it is / does.

@jayrdi
Copy link
Author

jayrdi commented Oct 16, 2018

Thanks everyone for working on this, and thanks @albangaignard for the script to crawl pages. The problem we have is that we are displaying the tools on a web page within a WordPress site so we can't use Python (or many scripting languages, unfortunately!).

Would it be possible to make a new endpoint parameter for this? So that at the end of the REST request I could just add something like &limit=1000 to the end of https://bio.tools/api/tool/?domain=RD-Connect&sort=name&ord=asc to increase the number of results pulled through?

@joncison
Copy link
Member

Understood @jayrdi - we'll take your suggestion when we take the other issues (#111, #325, #76, #310) - so this stays open until we have a resolution.

I personally want what you're proposing, but we have to be sure the implementation isn't a potential server-killer.

Me and @piotrgithub1 @hansioan will discuss / get back early Nov I expect

@piotrgithub1
Copy link

@joncison It seems we are getting more and more requests for "batch download" functionality, please bump this one up on your development todo list and we can have a code review of it mid next week if that's enough time?

@joncison
Copy link
Member

yup, sounds good. I'll speak to @hansioan today about it - better support for relationships between tool entries and use of publication data are also in the mix (from a different thread) so we'll draw up a plan / nail some of this stuff

@piotrgithub1
Copy link

I don't think this is a good idea, Hans should be focusing on other things right now so he actually makes some good progress on that front...

@joncison
Copy link
Member

joncison commented Jun 4, 2019

@hansioan @piotrgithub1 we also have the request from EBI re paging for XML downloads, also more flexibility on paging / downloads requested (albeit indirectly) by the reviewer of one of the papers recently accepted ... so I think we should try to improve things somehow, sooner rather than later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Concerns the bio.tools API. high priority We get to these once "critical priority" issues are done. search / sort / filter Concerns bio.tools search box, or content sorting & filtering.
Projects
None yet
Development

No branches or pull requests

5 participants