From 13431008c41fa356880c429ae7d38327a1730100 Mon Sep 17 00:00:00 2001
From: ghost <noreply@localhost>
Date: Sun, 23 Apr 2023 03:16:54 +0300
Subject: [PATCH] add options documentation

---
 config/app.php.txt | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/config/app.php.txt b/config/app.php.txt
index cc4ca92..34f6e90 100644
--- a/config/app.php.txt
+++ b/config/app.php.txt
@@ -149,10 +149,39 @@ define('CLEAN_HOST_LIMIT', 20);
 define('CLEAN_HOST_SECONDS_OFFSET', 3600);
 
 // API settings
+
+/*
+ * JSON API features
+ *
+ * When false - every the actions settings below will be ignored
+ *
+ */
 define('API_ENABLED', true);
 
+/*
+ * Search API
+ *
+ * When false - API_SEARCH_PAGINATION_RESULTS_LIMIT will be ignored
+ *
+ */
 define('API_SEARCH_ENABLED', true);
+
+/*
+ * Search results per page
+ *
+ */
 define('API_SEARCH_PAGINATION_RESULTS_LIMIT', 20);
 
+/*
+ * Hosts distribution API
+ *
+ * When false - API_HOSTS_FIELDS will be ignored
+ *
+ */
 define('API_HOSTS_ENABLED', true);
+
+/*
+ * Database host fields comma separated or * to share all the fields
+ *
+ */
 define('API_HOSTS_FIELDS', '`scheme`,`name`,`port`,`crawlPageLimit`,`robots`,`robotsPostfix`,`timeAdded`,`timeUpdated`'); // string: *|field names comma separated
\ No newline at end of file