From 5481dd7d322be9eaf3291f82960142ed506166b0 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 23 Jun 2020 13:30:03 +0200 Subject: [PATCH] README.md: Correcting+Cleanup request parameters documentation. --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c2348db..996ab94 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,11 @@ The protocol is simple and has 4 rules. The following parameters are supported in a request and are ordered from first to last below: -| # | Name | Required | Description | -| - | ---------- | -------- | ----------------------------------------------------------------------------- | -| 1 | Host | Yes | IP/Hostname to the api. | -| 2 | Port | No | Port number to the api (default `80`) | -| 3 | num_blocks | No | Number of blocks the api can drift before reported `down` (default 10) | -| 4 | version | No | API Version to check against, `v1` = standard, `v2` = Hyperion (default `v1`) | +| # | Name | Required | Description | +| - | ---------- | ----------------------- | -------------------------------------------------------------- | +| 1 | url | Yes (port default `80`) | http url to the api. `http(s)://(:)` | +| 2 | num_blocks | No (default `10`) | Number of blocks the api can drift before reported `down` | +| 3 | version | No (default `v1`) | API Version to check against, `v1` = standard, `v2` = Hyperion | ### Response