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

REST API #62

Open
jessicamrbr opened this issue Aug 8, 2019 · 10 comments · May be fixed by #70
Open

REST API #62

jessicamrbr opened this issue Aug 8, 2019 · 10 comments · May be fixed by #70
Assignees

Comments

@jessicamrbr
Copy link

I would like to access the full list of banks and information to try creates a comparative tool.

Do you make this data available in any way?

@apavlo
Copy link
Member

apavlo commented Aug 8, 2019

What do you mean by "full list of banks"?

@jessicamrbr
Copy link
Author

In the repository, initial data is available at:

dbdb.io/data/initial_data/

Would it be possible to access all current data?

@apavlo
Copy link
Member

apavlo commented Aug 9, 2019

Let me see about adding a REST API.

@apavlo apavlo changed the title Can I access the complete list of current banks? REST API Nov 22, 2019
@apavlo
Copy link
Member

apavlo commented Nov 22, 2019

I started looking into adding djangorestframework but it as a bit more complex than what I had time for. The REST API should be strictly read-only:

1c4738d

@pembo13
Copy link
Collaborator

pembo13 commented Jan 2, 2020

@apavlo what data would you like exposed in the API? Based on this thread, it looks like you only want it to be read-only. Should it only be accessible to users with accounts?

@apavlo
Copy link
Member

apavlo commented Jan 8, 2020

@pembo13 Yes, it should be read-only. The REST API can be open to the public.

@pembo13
Copy link
Collaborator

pembo13 commented Jan 14, 2020

@apavlo which models (data) do you want exposed? For example, I'm guessing System but not SystemVisit

@apavlo
Copy link
Member

apavlo commented Jan 14, 2020

It should just be System.

@pembo13
Copy link
Collaborator

pembo13 commented Apr 17, 2020

@apavlo please take a look at the demo, I'd like to know if you'd like me to add more fields, for example, the meta data: http://dbdb.devpreviews.com/api/v202004/systems

I do have a few questions:

  1. Should the API limited to users only?
  2. If limited to users only, should I allow them to generate an API key?
  3. I've put in throttling to limit to 4 requests per second

The code is in this branch if you'd like to review: https://github.com/cmu-db/dbdb.io/tree/issue_62

@pembo13
Copy link
Collaborator

pembo13 commented Jun 25, 2020

Fixed the Travis build in this branch as well.

@pembo13 pembo13 linked a pull request Sep 3, 2020 that will close this issue
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 a pull request may close this issue.

3 participants