Closed ihodes closed 9 years ago
only one minor suggestion towards more clarity.
Reviewed 1 of 1 files at r1. Review status: all files reviewed at latest revision, 1 unresolved discussion, some commit checks pending.
API.md, line 6 [r1] (raw file): Good one :)
I know that we cannot document everything slightly related to our setup, but do you think it is worth adding a basic curl command that does a get request featuring a simple auth as an example? Not strongly opinionated on this one. Feel free to ignore this suggestion if it is pretty obvious how to do that.
Comments from the review on Reviewable.io
I'm not opposed to it, though we don't show examples for the other calls, which are more annoying to make using cURL than just sending basic auth info. Is something like the below what you're looking for?
For example,
curl username:password@cycledash.example.com
```
if it's that easy (I didn't know that), never mind doing it :) LGTM in its current state.
Basic auth is super nice; you can also add a authorization header to the request, but that's annoying; required base64 encoding nonsense. I'm all for reworking out docs + adding example for everything, a la Stripe's amazing docs; filed an issue at https://github.com/hammerlab/cycledash/issues/827
fixes #809