search

RevolutionUC / revolutionuc-website

(legacy) Development repository for RevolutionUC website
MIT License
3 stars 4 forks source link

MLH_API_KEY ==> READONLY_API_KEY #144

Open domfarolino opened 6 years ago

domfarolino commented 6 years ago

We can generalize this better.

shaharyar123 commented 4 years ago

@domfarolino can you describe it a little bit?

domfarolino commented 4 years ago

Sure; our main API key gives full access to write and read the hacker data in our DB. MLH required a way to access our database to read our data, but we wanted to give them a read-only key (a key that when our sever would authenticate, would ensure requests with this key couldn’t actually perform writes/deletes). This is because we didn’t want them accidentally writing/messing with our data.

I named the key with read-only abilities “MLH_API_KEY” for them because we didn’t have another consumer of the key, but I think it would be good to make the name more general, in case we have more uses for a read-only key.

isiah-lloyd commented 4 years ago

Also last year we didn't have to give them API access to the database. We just created a CSV file from the database and they were fine with it.

On Mon, Oct 7, 2019, 5:41 PM Dominic Farolino notifications@github.com wrote:

Sure; our main API key gives full access to write and read the hacker data in our DB. MLH required a way to access our database to read our data, but we wanted to give them a read-only key (a key that when our sever would authenticate, would ensure requests with this key couldn’t actually perform writes/deletes). This is because we didn’t want them accidentally writing/messing with our data.

I named the key with read-only abilities “MLH_API_KEY” for them because we didn’t have another consumer of the key, but I think it would be good to make the name more general, in case we have more uses for a read-only key.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/RevolutionUC/revolutionuc-website/issues/144?email_source=notifications&email_token=AAGYGKATHYFBO4Q56J6Y2ZDQNOUIHA5CNFSM4EQRBSFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAR4VQA#issuecomment-539216576, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGYGKBFD65KANNKCULKF4TQNOUIHANCNFSM4EQRBSFA .

domfarolino commented 4 years ago

In that case maybe we don’t have a use for this kind of key at all, and can remove it.