job-queue-system/openapi.yaml at main · codingpratham/job-queue-system · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
openapi: 3.0.0
info:
  title: Job Queue System API
  description: API for managing a job queue using BullMQ and Redis.
  version: 1.0.0
servers:
  - url: http://localhost:3000
    description: Local development server
  - url: https://job-queue-system-sr2x.onrender.com/
    description: production server
paths:
  /job:
    post:
      summary: Add a new job to the queue
      description: Enqueues a new job with a specified type and payload. The job will be processed by background workers.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - type
                - payload
              properties:
                type:
                  type: string
                  description: The name or type of the job (e.g., 'email').
                  example: email
                payload:
                  type: object
                  description: The data payload required to process the job.
                  example:
                    to: "user@example.com"
                    subject: "Welcome!"
      responses:
        "200":
          description: Job successfully added to the queue
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Job added to queue"
                  jobId:
                    type: string
                    description: The unique identifier of the added job.
                    example: "1"