queue/openapi.yaml at main · jonbaldie/queue · 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
openapi: 3.0.3
info:
  title: Queue Service API
  version: 1.0.0
  description: A fast, lightweight, persistence-optional Deno queue service
servers:
  - url: http://localhost:3000
    description: Default local development server
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
security:
  - bearerAuth: []
paths:
  /health:
    get:
      summary: Health check
      description: Returns the health status of the service. Does not require authentication.
      security: []
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
        '405':
          description: Method not allowed
        '429':
          description: Too many requests (Rate limit exceeded)
  /queues:
    get:
      summary: List all queues
      description: Returns a JSON array of all active queue names.
      responses:
        '200':
          description: Array of queue names
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized
        '405':
          description: Method not allowed
        '429':
          description: Too many requests (Rate limit exceeded)
  /enqueue/{queue}:
    post:
      summary: Enqueue an item
      description: Adds a new payload to the specified queue.
      parameters:
        - in: path
          name: queue
          required: true
          schema:
            type: string
            maxLength: 128
          description: The name of the queue.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  description: The data to be enqueued. Can be any valid JSON type (string, object, etc.).
              required:
                - payload
      responses:
        '200':
          description: Payload successfully queued
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request - Invalid JSON or Queue name too long
        '401':
          description: Unauthorized
        '413':
          description: Payload too large (Max 1MB)
        '429':
          description: Too many requests (Rate limit exceeded)
        '507':
          description: Insufficient Storage - Queue full or too many queues
  /dequeue/{queue}:
    get:
      summary: Dequeue an item
      description: Removes and returns the oldest payload from the specified queue.
      parameters:
        - in: path
          name: queue
          required: true
          schema:
            type: string
            maxLength: 128
          description: The name of the queue.
      responses:
        '200':
          description: Successfully dequeued an item
          content:
            application/json:
              schema:
                description: The dequeued payload
        '204':
          description: No Content - Queue is empty
        '400':
          description: Bad Request - Queue name too long
        '401':
          description: Unauthorized
        '429':
          description: Too many requests (Rate limit exceeded)
  /peek/{queue}:
    get:
      summary: Peek at an item
      description: Returns the oldest payload from the specified queue without removing it.
      parameters:
        - in: path
          name: queue
          required: true
          schema:
            type: string
            maxLength: 128
          description: The name of the queue.
      responses:
        '200':
          description: Successfully retrieved an item
          content:
            application/json:
              schema:
                description: The peeked payload
        '204':
          description: No Content - Queue is empty
        '400':
          description: Bad Request - Queue name too long
        '401':
          description: Unauthorized
        '429':
          description: Too many requests (Rate limit exceeded)
  /length/{queue}:
    get:
      summary: Get queue length
      description: Returns the number of items currently in the specified queue.
      parameters:
        - in: path
          name: queue
          required: true
          schema:
            type: string
            maxLength: 128
          description: The name of the queue.
      responses:
        '200':
          description: The number of items in the queue
          content:
            text/plain:
              schema:
                type: integer
        '400':
          description: Bad Request - Queue name too long
        '401':
          description: Unauthorized
        '429':
          description: Too many requests (Rate limit exceeded)