Add route docs

api/jobs/handlers.py

@@ -341,7 +341,7 @@ class JobsHandler(base.RequestHandler):
 
         # Add job tags, config, attempt number, and/or previous job ID, if present
         tags            = submit.get('tags', None)
-        config          = submit.get('config', None)
+        config_         = submit.get('config', None)
         attempt_n       = submit.get('attempt_n', 1)
         previous_job_id = submit.get('previous_job_id', None)
 
@@ -359,7 +359,7 @@ class JobsHandler(base.RequestHandler):
                 inputs[x].check_access(self.uid, 'ro')
             destination.check_access(self.uid, 'rw')
 
-        job = Job(gear_name, inputs, destination=destination, tags=tags, config=config, attempt=attempt_n, previous_job_id=previous_job_id)
+        job = Job(gear_name, inputs, destination=destination, tags=tags, config_=config_, attempt=attempt_n, previous_job_id=previous_job_id)
         result = job.insert()
 
         return { "_id": result }
@@ -404,6 +404,32 @@ class JobHandler(base.RequestHandler):
         return Job.get(_id)
 
     def get_config(self, _id):
+        """
+        .. http:get:: /api/jobs/x/config.json
+
+            Returns the job's config as a downloadable json file
+
+            :statuscode 200: no error
+
+            **Example request**:
+
+            .. sourcecode:: http
+
+                GET /api/jobs/3/config.json HTTP/1.1
+
+            **Example response**:
+
+            .. sourcecode:: http
+
+                HTTP/1.1 200 OK
+                Content-Disposition: attachment; filename="config.json"
+                Content-Type: application/octet-stream
+
+                {
+                    "speed": 5
+                }
+        """
+
         if not self.superuser_request:
             self.abort(403, 'Request requires superuser')
 

api/jobs/jobs.py

@@ -13,7 +13,7 @@ from .. import config
 log = config.log
 
 class Job(object):
-    def __init__(self, name, inputs, destination=None, tags=None, attempt=1, previous_job_id=None, created=None, modified=None, state='pending', request=None, id_=None, config=None):
+    def __init__(self, name, inputs, destination=None, tags=None, attempt=1, previous_job_id=None, created=None, modified=None, state='pending', request=None, id_=None, config_=None):
         """
         Creates a job.
 
@@ -77,7 +77,7 @@ class Job(object):
         self.state           = state
         self.request         = request
         self.id_             = id_
-        self.config          = config
+        self.config          = config_
 
     @classmethod
     def load(cls, e):
@@ -100,7 +100,7 @@ class Job(object):
 
         d['_id'] = str(d['_id'])
 
-        return cls(d['name'], d.get('inputs', None), destination=d.get('destination', None), tags=d['tags'], attempt=d['attempt'], previous_job_id=d.get('previous_job_id', None), created=d['created'], modified=d['modified'], state=d['state'], request=d.get('request', None), id_=d['_id'], config=d.get('config', None))
+        return cls(d['name'], d.get('inputs', None), destination=d.get('destination', None), tags=d['tags'], attempt=d['attempt'], previous_job_id=d.get('previous_job_id', None), created=d['created'], modified=d['modified'], state=d['state'], request=d.get('request', None), id_=d['_id'], config_=d.get('config', None))
 
     @classmethod
     def get(cls, _id):