lib/cellect/server/api/sets.rb in cellect-server-0.1.2 vs lib/cellect/server/api/sets.rb in cellect-server-0.1.3

@@ -1,17 +1,37 @@
 module Cellect
   module Server
     class API
       class Sets < Grape::API
+        # GET /workflows/:workflow_id
+        # 
+        # Returns a sample from the specified workflow
+        # Accepts params
+        #   limit: integer, default 5
+        #   user_id: integer, optional
+        #   group_id: integer, optional
         get do
           workflow.sample selector_params
         end
         
+        # PUT /workflows/:workflow_id/add
+        # 
+        # Adds a subject to a workflow or updates the priority
+        # Accepts params
+        #   subject_id: integer
+        #   group_id: integer, required if grouped
+        #   priority: float, required if prioritized
         put :add do
           workflow.add update_params
           nil
         end
         
+        # PUT /workflows/:workflow_id/remove
+        # 
+        # Removes a subject from a workflow
+        # Accepts params
+        #   subject_id: integer
+        #   group_id: integer, required if grouped
         put :remove do
           workflow.remove update_params
           nil
         end
       end