search

caltechlibrary / dataset

dataset is a command line tool, Go package, shared library and Python package for working with JSON objects as collections
https://caltechlibrary.github.io/dataset
Other
24 stars 4 forks source link

datasetd document for query seems off #135

Open rsdoiel opened 1 week ago

rsdoiel commented 1 week ago

The descroption documenting how datasetd works for query seems off. At one point I mention the query name but at the top I only mention the fields (needed to apply the search values to the SQL in the query which is usually positional).

I need to correctly describe how datasetd supports the dsquery syntax, I need to also show how to associate a query with a query name so it is available on the datasetd /api/ tree.

rsdoiel commented 4 days ago

I've made improvements but I still want to work on documenting the YAML configuration file better since that is where the queries live.