search

divviup / janus

Experimental implementation of the Distributed Aggregation Protocol (DAP) specification.
Mozilla Public License 2.0
52 stars 14 forks source link

Documentation of aggregator API #1965

Open divergentdave opened 1 year ago

divergentdave commented 1 year ago

We should have documentation in the /docs/ directory introducing the aggregator API. This could be useful in future conversations about having other aggregators implement the same protocol. More immediately, I think it would be good to make task provisioning via the aggregator API at least as prominent as task provisioning via janus_cli provision-tasks with handcrafted YAML files. New users of Janus should be able to learn about this without diving into the source.

divergentdave commented 1 year ago

From https://github.com/divviup/janus/pull/2062/files#r1344200868:

Somewhere we ought to document the expected usage of the aggregator API for provisioning tasks, i.e. provision the helper first, then the leader using the generated auth token. Right now it's not clear that's the intended usage.