On Mon, 15 Aug 2016 22:48:38 +0200
Josef Skladanka <jskladan(a)redhat.com> wrote:
I spent most of today working on the new API docs for ResultsDB,
making use of the even better Apiary.io tool.
Before I put even more hours into it, please let me know, whether you
think it's fine at all - I'm yet to find a better tool for describing
APIs, so I'm definitely biased, but since it's the Documentation, it
needs to also be useful.
I am also trying to put more work towards documenting the attributes
and the "usual" queries, so please try and think about this aspect of
the docs too.
I think we talked about this in person earlier but I didn't write any
notes about it and I don't recall the details.
How exactly are we going to be using Groups? The first thing that comes
to mind is to group results by execution so that there would be a group
of results which were all produced from the same run of the same task.
That's kinda what we're using Job for in resultsdb 1.0 right now,
I realize that the docs for resultsdb are supposed to be
not-specific-to-taskotron but was there anything else we thought the
Group might be useful for?
Also, what do we want to do about a link to execdb? If we're planning
to have a group for each execution's results, that could be the group's
ref_url but that relies on convention which could change if Group is
used for more than just grouping results by execution.
I assume that the new API will also help fix some of the slowness we've
been seeing? IIRC, there were some schema changes which would probably
help with query time.