quarantine-help / quarantine-help-api Goto Github PK

As a developer, I want to have unit tests in place so I can be sure I'm not breaking anything.

We should probably have it in /api/v1/me/assigned-requests/ ? Probably should support some basic update works (change of status, cancellation), etc.

Create FAQ section in README and add errors faced with during local setup of the project on Windows to it as suggested. I'm working on it.

Probably a set of APIs like:

GET /api/v1/me/
PATCH /api/v1/me/

?

We use djagno rest framework TokenAuthentication flow : https://www.django-rest-framework.org/api-guide/authentication/#tokenauthentication

However, this is a 1 token per user, no expiration protocol. There is a hack to get it expire. Eg: https://stackoverflow.com/a/15380732

Lets do it.

Sadly, we dont have an error format set. Probably we can use some of the DRF in-house stuff. Right now, raise Exception() from the bakcend raises a 500 and thats it.

For eg, see: http://docs.quarantinehelp.space/#/Map%20view%20to%20list%20affected%20participants%20nearby/get_api_v1_crises__crisisId__affected_participants_

We return a lot of sensitive information there for the mapview. I would assume we might want to minimally do the following:

1. Anonymise the first name and last name (also email) to Fe Le e****@***.com ? Also, the phone number.
2. We need to also figure out if we can use the here maps python library to alter the precision a little bit. We are currently returning co-ordinates and the address. Dont know what would be the best way here.

We need it to track issues coming up.

Some tips:

• You cannot have more than 3 pending requests assigned to you at a time ?
• How many requests can you create at a time ?

Steps:

1. Django provides some techniques to provide initial data. Explore: https://docs.djangoproject.com/en/3.0/howto/initial-data/
2. We might need the following: a crisis object, a couple of participants both as HL and AF, and a couple of requests from AF participants.

I dont know if digitalocean is going to give us something out of the box. Otherwise, we might want to invest sometime in techniques django supports, etc.

We dont have this at this point.

An errand workflow:

1. AF creates a request
2. HL assigns it to themselves

We must send a notification (via E-mail?) to the HL participant that someone has started working on it.

https://github.com/bstarynk/helpcovid

Basile Starynkevitch (near Paris, France)

http://starynkevitch.net/Basile/

Currently we have some deploy scripts in deploy_scripts/. Django migrations are always a headache while continuous CI/CD on django, but lets see what we can build ?

Hi,

It would be better if we also add install instructions for windows as well

Django prints out weird stuff to the frontend, like "2020-04-04T11:17:37.784674Z", Lets push it to ISO format "2019-09-27T11:01:41.928158+00:00",

So right now the docs at http://docs.quarantinehelp.space/#/ is served from https://github.com/Quarantine-Help/quarantine-help-api/tree/master/docs/openapi.json

We have to edit the yaml over an editing service like https://editor.swagger.io/ and then convert it to JSON and update both files. This is kind of sad that we have to maintain two files. How about we only care about the YML file and some script takes care of keeping the JSON in sync ?

This should operate on participants and we have the lat and long there to work on.

We do not have this yet at at:
api/v1/crises/1/affected-participants/<participant_id>/requests/<request_id>/