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

Clarifications on what this project implements #125

Open
patata3000 opened this issue Jun 28, 2019 · 4 comments
Open

Clarifications on what this project implements #125

patata3000 opened this issue Jun 28, 2019 · 4 comments

Comments

@patata3000
Copy link

patata3000 commented Jun 28, 2019

Hey ! Thanks a lot for making this public.
I don't understand very well the structure of the project yet so I'm spending quite some time reading the code.
For example, I don't understand what provider_poller does. Why do you have a prv_api and an agency_api folder?
What should I do to authenticate with a new provider?

@HenriJ
Copy link
Contributor

HenriJ commented Jun 29, 2019

Hi @patata3000, thank you for your interest.
MDS has 2 sets of APIs : provider (exposed by providers) and agency (exposed by agency), both with almost the same content. This software intends to support both:

  • it exposes the agency API that providers can call
  • it polls (that's why you have a provider_poller) the providers API

In the end, you have (almost) the same data inside your database.
Authentication is oauth2 based (and included thanks to django-oauth-toolkit, although you can use a 3rd-party auth provider)

@patata3000
Copy link
Author

Could you give an overview of what you still need to implement?

@patata3000
Copy link
Author

patata3000 commented Jul 2, 2019

Moreover, I just realised something that confused me earlier. You're dividing agency API into 2 directories called agency_api and prv_api.
As you just stated, provider poller IS provider API.
If I understand correctly, prv_api are the part of the agency API spec where the data is generated by the provider (like devices) whereas the directory agency_api contains data generated by the agency (like service areas).
Am I right ?

Edit: just realised prv is for private. The rest of the question is still up though.

@patata3000
Copy link
Author

I don't understand what the fullrelease command does. Is it possible to have some details on it? :)

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

No branches or pull requests

2 participants