From 1c4904d3337595c636e6f1416faebad2a653df8d Mon Sep 17 00:00:00 2001 From: ghost Date: Sun, 23 Apr 2023 03:08:49 +0300 Subject: [PATCH] update readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3d68d57..4fde522 100644 --- a/README.md +++ b/README.md @@ -74,21 +74,21 @@ Could be enabled or disabled by `API_SEARCH_ENABLED` option ###### Request attributes ``` -GET action=search -GET query={string} - search request, empty if not provided -GET page={int} - search results page, 1 if not provided +GET action=search - required +GET query={string} - optional, search request, empty if not provided +GET page={int} - optional, search results page, 1 if not provided ``` ##### Hosts distribution API -Returns node hosts collected with fields provided in `API_HOSTS_FIELDS` settings. +Returns node hosts collected with fields provided in `API_HOSTS_FIELDS` option. Could be enabled or disabled by `API_HOSTS_ENABLED` option ###### Request attributes ``` -GET action=hosts +GET action=hosts - required ``` #### Roadmap / ideas