Update readme

Author: triole

conf/conf.yaml

@@ -1,11 +1,17 @@
 ---
 port: 17777 # port to listen at
+default_cache_lifetime: 5m # e.g.: 180s, 3m... 0 for no caching
+
 api: # list of api endpoints
   # url where to endpoint is reachable
   all.json:
 
-    # folder to be scanned for files
-    folder: ../testdata
+    # data source, can be folder, file or url
+    source: ../testdata
+
+    # method to read the data, to specify http request method
+    # not necessary for file reading
+    # method: get
 
     # only detect files which fit the regex filter
     regex_filter: ".+"
@@ -25,7 +31,7 @@ api: # list of api endpoints
 
     # set of return values to add to the final json
     # bool values are by default false and have to be enabled explicitely
-    return_values:
+    return:
       # an array of the file path split at the path separator
       split_path: false
 

readme.md

@@ -1,4 +1,4 @@
-# Tyson Tap ![build](https://github.com/triole/tap-waiter/actions/workflows/build.yaml/badge.svg) ![test](https://github.com/triole/tap-waiter/actions/workflows/test.yaml/badge.svg)
+# Tap Waiter ![build](https://github.com/triole/tap-waiter/actions/workflows/build.yaml/badge.svg) ![test](https://github.com/triole/tap-waiter/actions/workflows/test.yaml/badge.svg)
 
 <!-- toc -->
 
@@ -12,20 +12,26 @@
 
 ## Synopsis
 
-Tyson Tap offers an http api that serves json objects containing information about toml, yaml, json or markdown files that were indexed from specific folders.
+Tap Waiter offers an http api that serves json objects containing information about toml, yaml, json or markdown files that were indexed from specific folders.
 
 ## Configuration
 
 A configuration file is required and defines the listening port and the api endpoint definitions. A simple example can be found below and another in the `testdata` folder.
 
 ```go mdox-exec="tail -n +2 conf/conf.yaml"
 port: 17777 # port to listen at
+default_cache_lifetime: 5m # e.g.: 180s, 3m... 0 for no caching
+
 api: # list of api endpoints
   # url where to endpoint is reachable
   all.json:
 
-    # folder to be scanned for files
-    folder: ../testdata
+    # data source, can be folder, file or url
+    source: ../testdata
+
+    # method to read the data, to specify http request method
+    # not necessary for file reading
+    # method: get
 
     # only detect files which fit the regex filter
     regex_filter: ".+"
@@ -45,7 +51,7 @@ api: # list of api endpoints
 
     # set of return values to add to the final json
     # bool values are by default false and have to be enabled explicitely
-    return_values:
+    return:
       # an array of the file path split at the path separator
       split_path: false
 
@@ -84,7 +90,25 @@ order:
 Here are a few URL parameter examples which are hopefully self explanatory. Please keep in mind that special characters have to be url encoded.
 
 ```go mdox-exec="sh/display_test_urls.sh"
-
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/dump rxfilter=.+ url=/all.json
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/mapval/spec.yaml specs=[map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/markdown/1.md exp:[title1] key:front_matter.title] map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/markdown/1.md exp:[tag1 tag2] key:front_matter.tags] map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/yaml/cpx/data_aip.yaml exp:[Data Services @ AIP] key:title] map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/yaml/cpx/data_aip.yaml exp:[open] key:metadata.access] map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/yaml/cpx/data_aip.yaml exp:[vo IVOA Daiquiri] key:metadata.tags] map[content_file:/home/ole/rolling/golang/projects/tap-waiter/testdata/dump/yaml/cpx/data_aip.yaml exp:[https://data.aip.de] key:metadata.url]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_co_tag1.yaml specs=[map[exp:[markdown/1.md markdown/subfolder1/1.md markdown/subfolder1/2.md markdown/subfolder1/3.md markdown/subfolder1/4.md] urls:[/all.json?filter=front_matter.tags==tag1]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_eq_ivoa.yaml specs=[map[exp:[yaml/cpx/data_aip.yaml] urls:[/all.json?filter=metadata.tags==ivoa]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_eq_tag1.yaml specs=[map[exp:[markdown/subfolder1/1.md] urls:[/all.json?filter=front_matter.tags===tag1]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_nco_tag1.yaml specs=[map[exp:[markdown/subfolder2/1.md markdown/subfolder2/2.md markdown/subfolder2/3.md] urls:[/all.json?filter=front_matter.tags!=tag1]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_neq_ivoa.yaml specs=[map[exp:[markdown/subfolder2/3.md markdown/subfolder2/2.md markdown/subfolder2/1.md markdown/subfolder1/4.md markdown/subfolder1/3.md markdown/subfolder1/2.md markdown/subfolder1/1.md yaml/4.yaml markdown/no_front_matter.md markdown/1.md json/list.json html/3.html html/2.html html/1.html] urls:[/all.json?filter=tags!==ivoa&order=desc]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_filter_front_matter_tags_neq_tag1.yaml specs=[map[exp:[markdown/subfolder2/3.md markdown/subfolder2/2.md markdown/subfolder2/1.md markdown/subfolder1/4.md markdown/subfolder1/3.md markdown/subfolder1/2.md markdown/1.md] urls:[/all.json?filter=front_matter.tags!==tag1&order=desc]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_sortby_front_matter_title.yaml specs=[map[exp:[markdown/subfolder2/1.md markdown/subfolder1/1.md markdown/subfolder1/3.md markdown/subfolder1/4.md markdown/subfolder1/2.md markdown/1.md markdown/subfolder2/2.md markdown/subfolder2/3.md sort.yaml binary/binary_1k.file binary/binary_5k.file html/1.html html/2.html html/3.html html/more_than_10k.html html/sort.yaml json/list.json markdown/no_front_matter.md markdown/sort.yaml yaml/1.yaml yaml/2.yaml yaml/3.yaml yaml/4.yaml yaml/more_than_10k.yaml yaml/cpx/data_aip.yaml] urls:[/all.json?sortby=front_matter.title]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all_sortby_size.yaml specs=[map[exp:[yaml/more_than_10k.yaml html/more_than_10k.html binary/binary_5k.file binary/binary_1k.file yaml/1.yaml yaml/4.yaml yaml/2.yaml yaml/3.yaml yaml/cpx/data_aip.yaml html/3.html html/2.html html/1.html markdown/sort.yaml markdown/subfolder1/3.md markdown/subfolder2/1.md markdown/subfolder1/2.md markdown/subfolder2/2.md markdown/subfolder1/4.md markdown/1.md markdown/subfolder2/3.md markdown/subfolder1/1.md markdown/no_front_matter.md json/list.json sort.yaml html/sort.yaml] urls:[/all.json?sortby=size&order=desc]]]
+/home/ole/rolling/golang/projects/tap-waiter/testdata/specs/server/all.yaml specs=[map[exp:[sort.yaml binary/binary_1k.file binary/binary_5k.file html/1.html html/2.html html/3.html html/more_than_10k.html html/sort.yaml json/list.json markdown/1.md markdown/no_front_matter.md markdown/sort.yaml yaml/1.yaml yaml/2.yaml yaml/3.yaml yaml/4.yaml yaml/more_than_10k.yaml markdown/subfolder1/1.md markdown/subfolder1/2.md markdown/subfolder1/3.md markdown/subfolder1/4.md markdown/subfolder2/1.md markdown/subfolder2/2.md markdown/subfolder2/3.md yaml/cpx/data_aip.yaml] urls:[/all.json]]]
 ```
 
 # Filters

testdata/conf.yaml

@@ -1,6 +1,5 @@
 ---
 port: 17777
-# use like: 180s, 3m... 0 for no caching
 default_cache_lifetime: 5m
 
 api: