Opened 3 years ago

Last modified 8 months ago

#3214 assigned enhancement

Document all Data API messages

Reported by: dustin Owned by:
Priority: major Milestone: 0.9.5
Version: master Keywords: mq
Cc:

Description

Most Data API update methods send a message to indicate the change they are making, but these are mostly undocumented. We should write those down in the documentation.

Change History (9)

comment:1 Changed 2 years ago by dustin

  • Owner set to dustin
  • Status changed from new to assigned

comment:2 Changed 2 years ago by dustin

  • Owner dustin deleted

comment:3 Changed 22 months ago by sa2ajj

How can we "easily" determine what needs to be documented?

comment:4 Changed 22 months ago by dustin

dustin@euclid ~/code/buildbot/t/buildbot [master] $ grep -E '(produceEvent|mq\.produce)' master/buildbot/data/*.py
master/buildbot/data/base.py:    def produceEvent(self, msg, event):
master/buildbot/data/base.py:                self.master.mq.produce(routingKey, msg)
master/buildbot/data/builders.py:                self.master.mq.produce(('builders', str(builderid), 'stopped'),
master/buildbot/data/builders.py:            self.master.mq.produce(('builders', str(builderid), 'started'),
master/buildbot/data/buildrequests.py:                self.master.mq.produce(("control", "builds", str(b['buildid']), "stop"),
master/buildbot/data/buildrequests.py:            self.produceEvent(br, event)
master/buildbot/data/buildsets.py:        self.produceEvent(msg, "new")
master/buildbot/data/buildsets.py:        self.produceEvent(msg, "complete")
master/buildbot/data/buildslaves.py:        self.produceEvent(bs, 'connected')
master/buildbot/data/buildslaves.py:        self.produceEvent(bs, 'disconnected')
master/buildbot/data/builds.py:        self.master.mq.produce(("control", "builds",
master/buildbot/data/builds.py:        self.produceEvent(build, event)
master/buildbot/data/changes.py:        self.produceEvent(change, 'new')
master/buildbot/data/connector.py:    def produceEvent(self, rtype, msg, event):
master/buildbot/data/connector.py:        return rsrc.produceEvent(msg, event)
master/buildbot/data/logs.py:        self.produceEvent(build, event)
master/buildbot/data/masters.py:            self.produceEvent(
master/buildbot/data/masters.py:        self.produceEvent(
master/buildbot/data/properties.py:        # This event cannot use the produceEvent mecanism, as the properties resource type is a bit specific
master/buildbot/data/properties.py:        return self.master.mq.produce(routingKey, newprops)
master/buildbot/data/steps.py:        self.produceEvent(step, event)

comment:5 Changed 20 months ago by dustin

  • Milestone changed from 0.9.0 to 0.9.1

comment:6 Changed 12 months ago by tardyp

  • Milestone changed from 0.9.1 to 0.9.2

Ticket retargeted after milestone closed

comment:7 Changed 10 months ago by tardyp

  • Milestone changed from 0.9.2 to 0.9.3

Ticket retargeted after milestone closed

comment:8 Changed 9 months ago by tardyp

  • Milestone changed from 0.9.3 to 0.9.4

Ticket retargeted after milestone closed

comment:9 Changed 8 months ago by tardyp

  • Milestone changed from 0.9.4 to 0.9.5

Ticket retargeted after milestone closed

Note: See TracTickets for help on using tickets.