You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/api.yaml
+7-15Lines changed: 7 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@ info:
5
5
version: 1.0.0
6
6
servers:
7
7
- url: 'https'
8
-
9
8
paths:
10
9
/:
11
10
get:
@@ -22,7 +21,6 @@ paths:
22
21
schema:
23
22
type: string
24
23
example: /doc
25
-
26
24
/ping:
27
25
get:
28
26
operationId: pong
@@ -37,16 +35,15 @@ paths:
37
35
schema:
38
36
type: string
39
37
example: pong
40
-
41
38
/health/bucket:
42
39
get:
43
40
operationId: healthBucketCheck
44
41
tags:
45
42
- Health
46
43
summary: Check bucket health by uploading, downloading, and presigning a file
47
44
description: >
48
-
This endpoint uploads a randomly generated text file to the storage bucket,
49
-
verifies its content by downloading it, and returns a presigned URL for the file.
45
+
This endpoint uploads a randomly generated text file to the storage bucket, verifies its content by downloading it, and returns a presigned URL for the file.
46
+
50
47
responses:
51
48
200:
52
49
description: Successfully uploaded, verified, and presigned file.
@@ -72,7 +69,7 @@ paths:
72
69
- Health
73
70
summary: Send health check email
74
71
description: Sends a test email to verify email service functionality
75
-
security: []
72
+
security: []
76
73
parameters:
77
74
- name: to
78
75
in: query
@@ -102,16 +99,15 @@ paths:
102
99
message: "Invalid email address format"
103
100
path: "/health/email"
104
101
errorCode: "BAD_FORM"
105
-
106
102
/health/message:
107
103
get:
108
104
operationId: triggerDummyEvents
109
105
tags:
110
106
- Health
111
107
summary: Trigger dummy health check events
112
108
description: >
113
-
This endpoint triggers one or more dummy events through the event producer
114
-
for testing the messaging system (e.g., RabbitMQ or Kafka).
109
+
This endpoint triggers one or more dummy events through the event producer for testing the messaging system (e.g., RabbitMQ or Kafka).
110
+
115
111
parameters:
116
112
- name: nbEvent
117
113
in: query
@@ -152,7 +148,6 @@ paths:
152
148
error:
153
149
type: string
154
150
example: nbEvent must be between 1 and 500
155
-
156
151
/health/db:
157
152
get:
158
153
summary: Health check for the dummy database
@@ -200,7 +195,6 @@ paths:
200
195
totalPages: 1
201
196
number: 0
202
197
size: 5
203
-
204
198
components:
205
199
schemas:
206
200
ErrorResponse:
@@ -251,23 +245,21 @@ components:
251
245
- error
252
246
- message
253
247
- path
254
-
255
248
DateTime:
256
249
type: string
257
250
format: date-time
258
251
description: 'Date and time in ISO 8601 format (RFC 3339)'
0 commit comments