Changes between Version 1 and Version 2 of DevelopmentPlan-DataApi


Ignore:
Timestamp:
04/22/12 20:40:53 (14 months ago)
Author:
dustin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DevelopmentPlan-DataApi

    v1 v2  
    1010 
    1111= Components = 
     12 
     13The interfaces for all components but the update component are intended to be language-agnostic.  That is, they should be callable from JavaScript via HTTP, or via some other interface added to Buildbot after the fact. 
    1214 
    1315== Getter Component == 
     
    3840= Concrete Interface = 
    3941 
    40 The root of the data api is available at `self.master.data`.  The control and update components are implemented as sub-objects `self.master.data.control` and `self.master.data.update`, respectively.  The getter and message components' methods are available as methods of the `data` object itself. 
     42The root of the data api is available at `self.master.data`.  The first three components are implemented with the following methods: 
     43 
     44 * get -- get a resource 
     45 * getList -- get a list of resources 
     46 * subscribe -- subscribe to a resource or list, optionally getting its current state 
     47 * control -- perform an action on a resource 
     48 
     49The update component is available at `self.master.data.update`, and contains a number of ad-hoc methods needed by the process modules.