-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yaml
436 lines (434 loc) · 11.1 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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
openapi: 3.0.0
info:
title: HF API
description: OpenAPI specification for the Hack Forums API.
version: 2.0.0
servers:
- url: https://hackforums.net/api/v2
description: HF API Version 2
components:
responses:
UnauthorizedError:
description: Access token is missing or invalid
securitySchemes:
bearerAuth:
type: http
scheme: bearer
schemas:
AskMe:
type: object
description: ""
properties:
asks:
$ref: "#/components/schemas/Me"
Me:
type: object
description: "Permission: Basic & Advanced Info Permissions"
properties:
vault:
type: boolean
description: "API client vault balance"
uid:
type: boolean
username:
type: boolean
usergroup:
type: boolean
displaygroup:
type: boolean
additionalgroups:
type: boolean
postnum:
type: boolean
awards:
type: boolean
bytes:
type: boolean
threadnum:
type: boolean
avatar:
type: boolean
avatardimensions:
type: boolean
avatartype:
type: boolean
lastvisit:
type: boolean
usertitle:
type: boolean
website:
type: boolean
timeonline:
type: boolean
reputation:
type: boolean
referrals:
type: boolean
lastactive:
type: boolean
description: "Requires 'Advanced Info' permissions"
unreadpms:
type: boolean
description: "Requires 'Advanced Info' permissions"
invisible:
type: boolean
description: "Requires 'Advanced Info' permissions"
totalpms:
type: boolean
description: "Requires 'Advanced Info' permissions"
warningpoints:
type: boolean
description: "Requires 'Advanced Info' permissions"
AskForums:
type: object
description: ""
properties:
asks:
$ref: "#/components/schemas/Forums"
Forums:
type: object
description: "Permission: Posts Permissions"
properties:
_fid:
type: array
items:
type: number
fid:
type: boolean
name:
type: boolean
description:
type: boolean
type:
type: boolean
AskThreads:
type: object
description: ""
properties:
asks:
$ref: "#/components/schemas/Threads"
Threads:
type: object
description: "Permission: Posts Permissions"
properties:
_tid:
type: array
description: "Search directly by Thread ID(s)."
items:
type: number
_uid:
type: array
description: "Search by User ID(s)."
items:
type: number
_page:
type: array
description: "Optional: Used with _uid."
items:
type: number
_perpage:
type: array
description: "Optional: Used with _uid."
items:
type: number
tid:
type: boolean
uid:
type: boolean
fid:
type: boolean
subject:
type: boolean
description: "Return name of thread."
closed:
type: boolean
numreplies:
type: boolean
views:
type: boolean
dateline:
type: boolean
firstpost:
type: boolean
lastpost:
type: boolean
lastposter:
type: boolean
lastposteruid:
type: boolean
prefix:
type: boolean
icon:
type: boolean
poll:
type: boolean
username:
type: boolean
sticky:
type: boolean
bestpid:
type: boolean
AskPosts:
type: object
description: ""
properties:
asks:
$ref: "#/components/schemas/Posts"
Posts:
type: object
description: "Permission: Posts Permissions"
properties:
_pid:
type: array
description: "Search directly by Post ID(s)."
items:
type: number
_tid:
type: array
description: "Search directly by Thread ID(s)."
items:
type: number
_uid:
type: array
description: "Search directly by User ID(s)."
items:
type: number
_page:
type: array
description: "Optional: Used with _tid or _uid."
items:
type: number
_perpage:
type: array
description: "Optional: Used with _tid or _uid."
items:
type: number
pid:
type: boolean
tid:
type: boolean
uid:
type: boolean
fid:
type: boolean
dateline:
type: boolean
message:
type: boolean
subject:
type: boolean
edituid:
type: boolean
edittime:
type: boolean
editreason:
type: boolean
author:
type: array
description: "Array of Users"
items:
type: string
AskUsers:
type: object
description: ""
properties:
asks:
$ref: "#/components/schemas/Users"
Users:
type: object
description: "Permission: Users Permissions"
properties:
_uid:
type: array
description: "Search directly by User ID(s)."
items:
type: number
uid:
type: boolean
username:
type: boolean
usergroup:
type: boolean
displaygroup:
type: boolean
additionalgroups:
type: boolean
postnum:
type: boolean
description: "alias: post count"
awards:
type: boolean
myps:
type: boolean
description: "alias: bytes"
threadnum:
type: boolean
description: "alias: thread count"
avatar:
type: boolean
avatardimensions:
type: boolean
avatartype:
type: boolean
usertitle:
type: boolean
website:
type: boolean
timeonline:
type: boolean
reputation:
type: boolean
description: "alias: popularity"
referrals:
type: boolean
security:
- bearerAuth: []
paths:
/read/me:
post:
tags:
- read
summary: Returns information for the current user.
description: Returns information for the current user.
requestBody:
required: true
content:
application/json:
examples:
uid:
summary: return current user's uuid
value: { "asks": { "me": { "uid": true } } }
usernameUsergroup:
summary: return current user's username and usergroup
value: { "asks": { "me": { "uid": true, "usergroup": true } } }
schema:
$ref: "#/components/schemas/MeAsk"
responses:
"200": # status code
description: Me info
headers:
x-rate-limit-remaining:
schema:
type: integer
description: "Request limit per hour."
"401":
$ref: "#/components/responses/UnauthorizedError"
/read/forums:
post:
tags:
- read
summary: Returns information for provided forum(s).
description: Returns information for provided forum(s).
requestBody:
required: true
content:
"application/json":
examples:
lounge:
summary: return lounge forum information
value: { "asks": { "forums": { "_fid": [25], "name": true } } }
schema:
$ref: "#/components/schemas/AskForums"
responses:
"200": # status code
description: Forum(s) info
headers:
x-rate-limit-remaining:
schema:
type: integer
description: "Request limit per hour."
"401":
$ref: "#/components/responses/UnauthorizedError"
/read/threads:
post:
tags:
- read
summary: Returns information for provided thread(s).
description: Returns information for provided thread(s).
requestBody:
required: true
content:
"application/json":
examples:
lounge:
summary: return HF API Thread name
value:
{
"asks":
{ "threads": { "_tid": [6083782], "subject": true } },
}
schema:
$ref: "#/components/schemas/AskThreads"
responses:
"200": # status code
description: Thread(s) info
headers:
x-rate-limit-remaining:
schema:
type: integer
description: "Request limit per hour."
"401":
$ref: "#/components/responses/UnauthorizedError"
/read/posts:
post:
tags:
- read
summary: Returns information for provided post(s).
description: Returns information for provided post(s).
requestBody:
required: true
content:
"application/json":
examples:
lounge:
summary: return HF API post content
value:
{
"asks":
{ "posts": { "_pid": [59852445], "message": true } },
}
schema:
$ref: "#/components/schemas/AskPosts"
responses:
"200": # status code
description: Post(s) info
headers:
x-rate-limit-remaining:
schema:
type: integer
description: "Request limit per hour."
"401":
$ref: "#/components/responses/UnauthorizedError"
/read/users:
post:
tags:
- read
summary: Returns information for provided user(s).
description: Returns information for provided user(s).
requestBody:
required: true
content:
"application/json":
examples:
lounge:
summary: return user information for UID 1
value:
{
"asks":
{
"users":
{ "_uid": [1], "username": true, "postnum": true },
},
}
schema:
$ref: "#/components/schemas/AskUsers"
responses:
"200": # status code
description: User(s) info
headers:
x-rate-limit-remaining:
schema:
type: integer
description: "Request limit per hour."
"401":
$ref: "#/components/responses/UnauthorizedError"