The catalog.md readme file is intended to be maintained as a catalog of all known queries.
The file is auto-generated from Telliot, which would be updated as new queries are recognized.
Each query is given a short string called the tag that uniquely identifies it in the catalog. These tags will be manually added/maintained for all known queries. Alternates for the name tag could include cid (catalog ID), sku etc.... Might have been nice to use qid (queryID) but that might get confused with the hash.
The tag may end up becoming the main identifier used by users because it will be the shortest/most convenient.
Queries have an active flag. If not active, a query should not be relied upon.
Should we consider having another flag indicating that it is supported/recognized by the team e.g. approved, certified?
Nah, I'm pretty sure if it's approved that's what a PR to this repo is... But can you update the readme with some (this) basic info on it and then I'll merge!
The
catalog.md
readme file is intended to be maintained as a catalog of all known queries. The file is auto-generated from Telliot, which would be updated as new queries are recognized.Each query is given a short string called the
tag
that uniquely identifies it in the catalog. These tags will be manually added/maintained for all known queries. Alternates for the nametag
could includecid
(catalog ID),sku
etc.... Might have been nice to useqid
(queryID) but that might get confused with the hash. Thetag
may end up becoming the main identifier used by users because it will be the shortest/most convenient.Queries have an
active
flag. If not active, a query should not be relied upon.Should we consider having another flag indicating that it is supported/recognized by the team e.g.
approved
,certified
?