deploy: 82614ca441

overseerr-api.yml

@@ -1278,6 +1278,27 @@ components:
             allowSelfSigned:
               type: boolean
               example: false
+    Job:
+      type: object
+      properties:
+        id:
+          type: string
+          example: job-name
+        type:
+          type: string
+          enum: [process, command]
+        interval:
+          type: string
+          enum: [short, long, fixed]
+        name:
+          type: string
+          example: A Job Name
+        nextExecutionTime:
+          type: string
+          example: '2020-09-02T05:02:23.000Z'
+        running:
+          type: boolean
+          example: false
     PersonDetail:
       type: object
       properties:
@@ -2214,23 +2235,7 @@ paths:
               schema:
                 type: array
                 items:
-                  type: object
-                  properties:
-                    id:
-                      type: string
-                      example: job-name
-                    name:
-                      type: string
-                      example: A Job Name
-                    type:
-                      type: string
-                      enum: [process, command]
-                    nextExecutionTime:
-                      type: string
-                      example: '2020-09-02T05:02:23.000Z'
-                    running:
-                      type: boolean
-                      example: false
+                  $ref: '#/components/schemas/Job'
   /settings/jobs/{jobId}/run:
     post:
       summary: Invoke a specific job
@@ -2249,23 +2254,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  id:
-                    type: string
-                    example: job-name
-                  type:
-                    type: string
-                    enum: [process, command]
-                  name:
-                    type: string
-                    example: A Job Name
-                  nextExecutionTime:
-                    type: string
-                    example: '2020-09-02T05:02:23.000Z'
-                  running:
-                    type: boolean
-                    example: false
+                $ref: '#/components/schemas/Job'
   /settings/jobs/{jobId}/cancel:
     post:
       summary: Cancel a specific job
@@ -2281,26 +2270,39 @@ paths:
       responses:
         '200':
           description: Canceled job returned
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Job'
+  /settings/jobs/{jobId}/schedule:
+    post:
+      summary: Modify job schedule
+      description: Re-registers the job with the schedule specified. Will return the job in JSON format.
+      tags:
+        - settings
+      parameters:
+        - in: path
+          name: jobId
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
         content:
           application/json:
             schema:
               type: object
               properties:
-                  id:
-                    type: string
-                    example: job-name
-                  type:
+                schedule:
                   type: string
-                    enum: [process, command]
-                  name:
-                    type: string
-                    example: A Job Name
-                  nextExecutionTime:
-                    type: string
-                    example: '2020-09-02T05:02:23.000Z'
-                  running:
-                    type: boolean
-                    example: false
+                  example: '0 */5 * * * *'
+      responses:
+        '200':
+          description: Rescheduled job
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Job'
   /settings/cache:
     get:
       summary: Get a list of active caches
@@ -2398,7 +2400,7 @@ paths:
                       example: Server ready on port 5055
                     timestamp:
                       type: string
-                      example: 2020-12-15T16:20:00.069Z
+                      example: '2020-12-15T16:20:00.069Z'
   /settings/notifications/email:
     get:
       summary: Get email notification settings