Merge lp:~joetalbott/ubuntu-ci-services-itself/branch_listener_update into lp:ubuntu-ci-services-itself

[Joe Talbott]

branch-listener - Flesh out the design document a bit.

branch-listener - Flesh out the design document a bit.

[Francis Ginther (fginther)]

Approve.

review: Approve

=== modified file 'docs/api/branch-listener.rst'
--- docs/api/branch-listener.rst	2013-11-20 14:40:42 +0000
+++ docs/api/branch-listener.rst	2013-11-25 21:53:31 +0000
@@ -1,31 +1,4 @@
 Branch listener
 ===============
 
-Inbound API
------------
-
-**/listen**
-    GET variables
-
-    * branch - Branch to check for MPs. (required)
-    * notification URI - URI to send notifications to. (required)
-
-Outbound API
-------------
-
-**<URI>/get_constraints**
-    GET variables
-
-    * branch - Branch changes occurred on. (required)
-
-**<URI>/mp_status**
-    GET variables
-
-    * branch - Branch
-    * status - Whether the MP meets the constraints for the branch. One of 'invalid', 'valid'
-
-Services Used
--------------
-
-* LP API
-* Ticket Manager API
+To Be Determined.
 
=== modified file 'docs/components/branch-listener.rst'
--- docs/components/branch-listener.rst	2013-11-16 10:12:08 +0000
+++ docs/components/branch-listener.rst	2013-11-25 21:53:31 +0000
@@ -4,3 +4,37 @@
 *Purpose:*
 
 * Track MPs and the trunks for the components involved in a ticket. tarmac-ish.  
+
+
+Requirements
+------------
+
+https://bugs.launchpad.net/tarmac/+bug/1253770
+
+* Determine when an MP has been updated and run tests accordingly.
+* Given a trunk branch, return a list of all MPs available.
+* Given an MP and a revision ID, check and merge.
+* Apply tests to non-Approved branches and after any update/commit.
+
+Tarmac meets most of our needs.
+
+Service Requirements (Juju)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Read access to LP.
+* MP comment write access to LP.
+* Tarmac installed (currently the stable release is being investigated but a fork might be in order)
+
+Proposed API
+------------
+
+Inbound
+~~~~~~~
+
+* check_branch/?branch=<branch>[&revision=<revision>]
+* merge_branch/?branch=<branch>[&revision=<revision>]
+
+Outbound
+~~~~~~~~
+
+Currently all outbound APIs will be those tarmac already uses.