commit 197063b7afca942374f6c0ae3c4f66995cb285ff Author: kudrom kudrom@riseup.net Date: Fri Aug 29 15:59:49 2014 +0200

Improved RESTfulness of the bouncer API. --- oonib.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/oonib.md b/oonib.md index 81d83a3..e653b02 100644 --- a/oonib.md +++ b/oonib.md @@ -575,6 +575,8 @@ This will return a list of required collectors.

Currently a client has two ways to request the required collectors.

+#### POST /bouncer/test-helpers + The first and old way is to provide a bunch of test-helpers, oonib then will return the identity of the collectors and the addresses of machines that can run the requested test helpers.

@@ -615,6 +617,8 @@ helpers an error message is returned: {'error': 'test-helper-not-found'} ```

+#### POST /bouncer/net-tests + The second and policy respectful way is to provide a bunch of nettests, then the bouncer will return the identity of the machines that: 1. Can run the required test-helpers @@ -669,9 +673,3 @@ If it's not possible to find a collector for the request, oonib will respond wit ``` {'error': 'collector-not-found'} ``` - -Both ways to communicate with the bouncer are explicitly set with the proper JSON object in the -payload of the POST request. If an invalid JSON object is provided, oonib will respond with: -``` -{'error': 'test-helpers-or-net-test-key-missing'} -```