-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
279 lines (279 loc) · 8.26 KB
/
openapi.yaml
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
openapi: "3.0.0"
info:
title: "Octoflow API"
version: "1.0.0"
servers:
- url: "https://v2.gitlogs.xyz"
description: "Production"
paths:
/kittycat:
get:
summary: "Get Webhook"
operationId: "getWebhookInfo"
parameters:
- name: "id"
in: "query"
required: true
schema:
type: "string"
description: "The ID of the webhook"
responses:
'200':
description: "Webhook info retrieved successfully"
content:
application/json:
schema:
$ref: "#/components/schemas/WebhookInfo"
'400':
description: "Bad Request"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrBadRequest"
'404':
description: "Not Found"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrNotFound"
post:
summary: "Handle Webhook"
operationId: "handleGithubWebhook"
parameters:
- name: "id"
in: "query"
required: true
schema:
type: "string"
description: "The ID of the webhook"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GithubWebhookPayload"
responses:
'200':
description: "Webhook handled successfully"
content:
text/plain:
schema:
type: "string"
'400':
description: "Bad Request"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrBadRequest"
'401':
description: "Unauthorized"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrUnauthorized"
'404':
description: "Not Found"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrNotFound"
'500':
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrInternalServerError"
/api/stats:
get:
summary: "Client Stats"
operationId: "apiStats"
responses:
'200':
description: "API stats retrieved successfully"
content:
text/plain:
schema:
type: "string"
example: "10,1000,5"
/api/events/list:
get:
summary: "Supported Events"
operationId: "apiEventsListView"
responses:
'200':
description: "List of supported events retrieved successfully"
content:
text/plain:
schema:
type: "string"
example: "- push\n- pull_request"
components:
schemas:
WebhookInfo:
type: "object"
properties:
broken:
type: "boolean"
description: "Indicates if the webhook is broken"
comment:
type: "string"
description: "Comment associated with the webhook"
eventModifiers:
type: "array"
items:
$ref: "#/components/schemas/EventModifier"
description: "List of event modifiers for the webhook"
repositories:
type: "array"
items:
$ref: "#/components/schemas/Repository"
description: "List of repositories associated with the webhook"
EventModifier:
type: "object"
properties:
id:
type: "string"
description: "ID of the event modifier"
events:
type: "array"
items:
type: "string"
description: "List of events the modifier applies to"
repoID:
type: "string"
description: "ID of the repository"
blacklisted:
type: "boolean"
description: "Indicates if the modifier is blacklisted"
whitelisted:
type: "boolean"
description: "Indicates if the modifier is whitelisted"
redirectChannel:
type: "string"
description: "Channel to redirect the event to"
priority:
type: "integer"
description: "Priority of the event modifier"
Repository:
type: "object"
properties:
repoID:
type: "string"
description: "ID of the repository"
repoName:
type: "string"
description: "Name of the repository"
channelID:
type: "string"
description: "ID of the channel"
createdAt:
type: "string"
format: "date-time"
description: "Creation date of the repository"
GithubWebhookPayload:
type: "object"
properties:
action:
type: "string"
description: "Action performed in the event"
repository:
type: "object"
properties:
id:
type: "integer"
description: "ID of the repository"
name:
type: "string"
description: "Name of the repository"
full_name:
type: "string"
description: "Full name of the repository"
sender:
type: "object"
properties:
login:
type: "string"
description: "Login of the sender"
id:
type: "integer"
description: "ID of the sender"
ErrBadRequest:
type: "object"
properties:
error:
type: "object"
properties:
code:
type: "string"
enum: ["BAD_REQUEST"]
description: "A machine readable error code."
example: "BAD_REQUEST"
message:
type: "string"
description: "A human readable explanation of what went wrong"
requestId:
type: "string"
description: "Please always include the requestId in your error report"
example: "req_1234"
required: ["code", "message", "requestId"]
required: ["error"]
ErrUnauthorized:
type: "object"
properties:
error:
type: "object"
properties:
code:
type: "string"
enum: ["UNAUTHORIZED"]
description: "A machine readable error code."
example: "UNAUTHORIZED"
message:
type: "string"
description: "A human readable explanation of what went wrong"
requestId:
type: "string"
description: "Please always include the requestId in your error report"
example: "req_1234"
required: ["code", "message", "requestId"]
required: ["error"]
ErrNotFound:
type: "object"
properties:
error:
type: "object"
properties:
code:
type: "string"
enum: ["NOT_FOUND"]
description: "A machine readable error code."
example: "NOT_FOUND"
message:
type: "string"
description: "A human readable explanation of what went wrong"
requestId:
type: "string"
description: "Please always include the requestId in your error report"
example: "req_1234"
required: ["code", "message", "requestId"]
required: ["error"]
ErrInternalServerError:
type: "object"
properties:
error:
type: "object"
properties:
code:
type: "string"
enum: ["INTERNAL_SERVER_ERROR"]
description: "A machine readable error code."
example: "INTERNAL_SERVER_ERROR"
message:
type: "string"
description: "A human readable explanation of what went wrong"
requestId:
type: "string"
description: "Please always include the requestId in your error report"
example: "req_1234"
required: ["code", "message", "requestId"]
required: ["error"]