search

OpenTechFund / bypass-otf_proxy

1 stars 1 forks source link

Specifications for API reporting #65

Closed maxpearl closed 3 years ago

maxpearl commented 3 years ago

JSON request and response.

maxpearl commented 3 years ago

Committed modifications to the specifications (I'd forgotten we'd added this to the repo already) and some new docs to this repo. @jheretic have a looksee. Let me know if there's anything amiss.

jheretic commented 3 years ago

@maxpearl this looks great! The only thing I'd add right now is an indication in the spec of which (if any) parameters are required vs optional. If failure_detail is being used to indicate non-HTTP errors, then probably domain_status and domain_content at least should be optional?

maxpearl commented 3 years ago

Thanks, this is helpful. I've added required and optional fields. I'm assuming two kinds of reports - automated which will send the domain http status and such, and manual, which won't.