{"id":30799388,"url":"https://github.com/triole/tap-waiter","last_synced_at":"2026-04-17T01:02:03.365Z","repository":{"id":235201695,"uuid":"790283532","full_name":"triole/tap-waiter","owner":"triole","description":"toml, yaml, json and markdown indexer that offers a web server to fetch information about these files","archived":false,"fork":false,"pushed_at":"2025-11-13T22:06:02.000Z","size":291,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-14T00:10:54.968Z","etag":null,"topics":["indexer","json","webserver"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/triole.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-22T15:45:29.000Z","updated_at":"2025-11-13T22:06:06.000Z","dependencies_parsed_at":"2024-04-23T12:46:23.597Z","dependency_job_id":"eb5a90de-6749-4a3e-80e4-abb897c6b7ee","html_url":"https://github.com/triole/tap-waiter","commit_stats":null,"previous_names":["triole/yaml-indexer","triole/tyson-joiner","triole/tyson-tap","triole/tap-waiter"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/triole/tap-waiter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/triole%2Ftap-waiter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/triole%2Ftap-waiter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/triole%2Ftap-waiter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/triole%2Ftap-waiter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/triole","download_url":"https://codeload.github.com/triole/tap-waiter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/triole%2Ftap-waiter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31910585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"ssl_error","status_checked_at":"2026-04-16T18:21:47.142Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["indexer","json","webserver"],"created_at":"2025-09-05T19:11:40.691Z","updated_at":"2026-04-17T01:02:03.128Z","avatar_url":"https://github.com/triole.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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)\n\n\u003c!-- toc --\u003e\n\n- [Synopsis](#synopsis)\n- [Configuration](#configuration)\n- [URL Parameters](#url-parameters)\n- [Filters](#filters)\n  - [Logical Operators](#logical-operators)\n\n\u003c!-- /toc --\u003e\n\n## Synopsis\n\nTap Waiter offers an http api that serves json objects containing information about toml, yaml, json or markdown files that were indexed from specific folders.\n\n## Configuration\n\nA 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.\n\n```go mdox-exec=\"tail -n +2 conf/conf.yaml\"\nbind: 0.0.0.0:17777 # bind server to\ndefault_cache_lifetime: 5m # e.g.: 180s, 3m... 0 for no caching\n\napi: # list of api endpoints\n  # url where to endpoint is reachable\n  all.json:\n\n    # data source, can be folder, file or url\n    source: ../testdata\n\n    # method to read the data, to specify http request method\n    # not necessary for file reading\n    # method: get\n\n    # only detect files which fit the regex filter\n    regex_filter: \".+\"\n\n    # name of all files that are considered to be sort files, there can be\n    # multiple of them, each one refers to its folder and possible substructures\n    sort_file_name: sort.yaml\n\n    # files that should not be returned in index\n    regex_ignore_list:\n      - sort.yaml\n\n    # maximum file size up to which file content will appear in json\n    # default is 10K to avoid too big json outputs\n    # only relevant if content return is enabled\n    max_return_size: 10KB\n\n    # set of return values to add to the final json\n    # bool values are by default false and have to be enabled explicitely\n    return:\n      # an array of the file path split at the path separator\n      split_path: false\n\n      # file size in bytes\n      size: false\n\n      # file created date\n      created: false\n\n      # file modified date\n      lastmod: false\n\n      # display file content, note max_return_size\n      content: false\n\n      # front matter of markdown files can be split from content\n      # set content=false and split_markdown_front_matter=true to\n      # have only front matter in the final json\n      split_markdown_front_matter: false\n```\n\n# Sort Files\n\nSort files contain a list that determines the `order` in which files in the same or in sub folders shell be returned in the index. The `exclusive` entry is a boolean value that switches between excluding files that are not on the list and displaying them. If true, the index will only contain the exact elements that are in the `order` list even if there are more files. If false, index will consist of the entries of `order` and any other relevant files will follow below.\n\n```go mdox-exec=\"tail -n +2 testdata/sort.yaml\"\nexclusive: true\norder:\n  - filter\n  - dump\n  - markdown/subfolder2/1.md\n```\n\n# URL Parameters\n\nHere are a few URL parameter examples which are hopefully self explanatory. Please keep in mind that special characters have to be url encoded.\n\n```go mdox-exec=\"sh/display_test_urls.sh\"\n/all.json\n/all.json?filter=front_matter.tags!=tag1\n/all.json?filter=front_matter.tags===tag1\n/all.json?filter=front_matter.tags==tag1\n/all.json?filter=front_matter.tags!==tag1\u0026order=desc\n/all.json?filter=metadata.tags==ivoa\n/all.json?filter=tags!==ivoa\u0026order=desc\n/all.json?sortby=front_matter.title\n/all.json?sortby=size\u0026order=desc\n```\n\n# Filters\n\nFilters supporting different logical operators are applied by url parameter. A filter contains of a `prefix` defining the part of the document to consider, an `operator` specifying the logical operation and a `suffix` which resembles the filter criterion. The content to be considered can be an array. For example when a markdown file has a list of tags. Therefore the filter criterion can be a comma separated list as well (see above).\n\n## Logical Operators\n\n| op               | returns a document if...                                               |\n|------------------|------------------------------------------------------------------------|\n| ===              | ...prefix and suffix are exactly equal                                 |\n| !==              | ...prefix and suffix are not exactly equal                             |\n| ==               | ...prefix contains suffix                                              |\n| !=               | ...prefix does not contain suffix                                      |\n| ==~              | ...if every regex suffix matches every prefix                          |\n| =~               | ...if every regex suffix matches at least one prefix                   |\n|                  |                                                                        |\n| ** exactly equal | equal regarding size and every single entry                            |\n| ** contains      | equal regarding every element of the suffix can be found in the prefix |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriole%2Ftap-waiter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftriole%2Ftap-waiter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriole%2Ftap-waiter/lists"}