-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
657 lines (624 loc) · 19.9 KB
/
openapi.yaml
File metadata and controls
657 lines (624 loc) · 19.9 KB
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
openapi: 3.0.3
info:
title: Home Access Center API
description: |
## Authentication
All endpoints (except the root endpoint) require authentication via query parameters:
- `user`: Your Home Access Center username
- `pass`: Your Home Access Center password
## Caching
- Login sessions are cached for 30 minutes
- Page data is cached for 5 minutes
- Add `?no_cache=true` to any endpoint to bypass cache
## Base URL
This API is hosted at: `https://hac.packjack.dev`
version: 0.1.0
contact:
name: Home Access Center API
license:
name: MIT
servers:
- url: https://hac.packjack.dev
description: Production server
tags:
- name: Student Info
description: Basic student information
- name: Classes
description: Class-related information
- name: Assignments
description: Assignment and grade data
- name: Reports
description: Report cards and transcripts
paths:
/:
get:
summary: API Information
description: Returns welcome message and available routes
tags:
- Student Info
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
title:
type: string
example: "Welcome to the Home Access Center API!"
message:
type: string
example: "Interactive API documentation available at /docs"
docs_url:
type: string
example: "https://hac.packjack.dev/docs"
openapi_spec:
type: object
properties:
yaml:
type: string
example: "https://hac.packjack.dev/openapi.yaml"
json:
type: string
example: "https://hac.packjack.dev/openapi.json"
routes:
type: array
items:
type: string
example: ["/api/name", "/api/info", "/api/classes"]
cache_param:
type: string
example: "Add ?no_cache=true to any endpoint to bypass cache"
/api/:
get:
summary: API Information (alternate route)
description: Returns welcome message and available routes
tags:
- Student Info
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/WelcomeMessage'
/docs:
get:
summary: Interactive API Documentation
description: Serves an interactive Swagger UI interface for exploring and testing the API
tags:
- Student Info
responses:
'200':
description: HTML page with Swagger UI
content:
text/html:
schema:
type: string
example: "<!DOCTYPE html>..."
/openapi.yaml:
get:
summary: OpenAPI Specification (YAML)
description: Returns the OpenAPI 3.0 specification in YAML format
tags:
- Student Info
responses:
'200':
description: OpenAPI specification in YAML format
content:
application/yaml:
schema:
type: string
/openapi.json:
get:
summary: OpenAPI Specification (JSON)
description: Returns the OpenAPI 3.0 specification in JSON format
tags:
- Student Info
responses:
'200':
description: OpenAPI specification in JSON format
content:
application/json:
schema:
type: object
/api/name:
get:
summary: Get Student Name
description: Retrieves the student's name from Home Access Center
tags:
- Student Info
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "John Doe"
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/info:
get:
summary: Get Student Information
description: Retrieves detailed student profile information
tags:
- Student Info
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
cohort_year:
type: string
example: "2027"
counselor:
type: string
example: "Jones, Natalie"
dob:
type: string
example: "5/2/2009"
grade:
type: string
example: "11"
language:
type: string
example: "English"
name:
type: string
example: "MacGregor, Jackson North"
school:
type: string
example: "Seven Lakes HS"
example:
cohort_year: "2027"
counselor: "Jones, Natalie"
dob: "5/2/2009"
grade: "11"
language: "English"
name: "MacGregor, Jackson North"
school: "Seven Lakes HS"
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/classes:
get:
summary: Get Class List
description: Retrieves a list of the student's classes
tags:
- Classes
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/Short'
- $ref: '#/components/parameters/SixWeeks'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: string
example: ["AP Calculus BC", "English III Honors", "AP Chemistry"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/averages:
get:
summary: Get Class Averages
description: Retrieves current averages for all classes
tags:
- Classes
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/Short'
- $ref: '#/components/parameters/SixWeeks'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
additionalProperties:
type: string
example:
"AP Calculus BC": "95"
"English III Honors": "92"
"AP Chemistry": "88"
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/assignments:
get:
summary: Get Assignments
description: Retrieves detailed assignment information for all classes
tags:
- Assignments
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/Short'
- $ref: '#/components/parameters/SixWeeks'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
additionalProperties:
type: array
items:
type: array
items:
type: string
example:
"AP Calculus BC":
- ["10/15/2024", "Quiz 3", "Major Grades", "95", "100"]
- ["10/10/2024", "Homework 5", "Daily Grades", "10", "10"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/gradebook:
get:
summary: Get Complete Gradebook
description: Retrieves assignments with grades and weightings for all classes
tags:
- Assignments
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/Short'
- $ref: '#/components/parameters/SixWeeks'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
additionalProperties:
type: object
properties:
assignments:
type: array
items:
type: array
items:
type: string
weightings:
type: array
items:
type: array
items:
type: string
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/weightings:
get:
summary: Get Grade Weightings
description: Retrieves grade category weightings for all classes
tags:
- Classes
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/Short'
- $ref: '#/components/parameters/SixWeeks'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
additionalProperties:
type: array
items:
type: array
items:
type: string
description: "Array containing: [category, points_earned, total_points, percentage, weight, weighted_value]"
example:
"AP PHYSICS 1 GT":
- ["Major", "187.0000", "200.00", "93.500%", "70.00", "65.450000"]
- ["Minor", "658.0000", "800.00", "82.250%", "20.00", "16.450000"]
- ["Other", "197.0000", "400.00", "49.250%", "10.00", "4.925000"]
"AP CALCULUS BC":
- ["Major", "162.0000", "200.00", "81.000%", "70.00", "56.700000"]
- ["Minor", "348.0000", "400.00", "87.000%", "20.00", "17.400000"]
- ["Other", "1397.0000", "1400.00", "99.785%", "10.00", "9.978600"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/reportcard:
get:
summary: Get Report Card
description: Retrieves report card tables with grades per marking period
tags:
- Reports
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: array
items:
type: string
example:
- ["Course", "Teacher", "MP1", "MP2", "Sem1", "MP3", "MP4", "Sem2", "Final"]
- ["AP Calculus BC", "Smith, John", "95", "93", "94", "96", "94", "95", "95"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/ipr:
get:
summary: Get Interim Progress Report
description: Retrieves interim progress report data
tags:
- Reports
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: array
items:
type: string
example:
- ["Course", "Teacher", "Grade", "Absences", "Tardies"]
- ["AP Calculus BC", "Smith, John", "95", "0", "0"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/transcript:
get:
summary: Get Full Transcript
description: Retrieves complete transcript with GPA and semester information
tags:
- Reports
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
rank:
type: string
example: "15 of 450"
quartile:
type: string
example: "Top 25%"
Weighted GPA:
type: string
example: "4.35"
Unweighted GPA:
type: string
example: "3.95"
additionalProperties:
type: object
properties:
year:
type: string
semester:
type: string
credits:
type: string
data:
type: array
items:
type: array
items:
type: string
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/api/rank:
get:
summary: Get GPA Rank
description: Retrieves GPA rank and quartile information
tags:
- Reports
parameters:
- $ref: '#/components/parameters/Username'
- $ref: '#/components/parameters/Password'
- $ref: '#/components/parameters/Link'
- $ref: '#/components/parameters/NoCache'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
rank:
type: string
example: "15 of 450"
quartile:
type: string
example: "Top 25%"
Weighted GPA:
type: string
example: "4.35"
Unweighted GPA:
type: string
example: "3.95"
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
components:
parameters:
Username:
name: user
in: query
required: true
description: Home Access Center username
schema:
type: string
example: "student123"
Password:
name: pass
in: query
required: true
description: Home Access Center password
schema:
type: string
format: password
example: "mypassword"
Link:
name: link
in: query
required: false
description: Home Access Center base URL (defaults to https://homeaccess.katyisd.org)
schema:
type: string
format: uri
default: https://homeaccess.katyisd.org
example: "https://homeaccess.katyisd.org"
Short:
name: short
in: query
required: false
description: Whether to return shortened class names
schema:
type: boolean
default: false
example: true
SixWeeks:
name: six_weeks
in: query
required: false
description: Specific six weeks period to retrieve assignments for
schema:
type: string
example: "1"
NoCache:
name: no_cache
in: query
required: false
description: Bypass cache and fetch fresh data
schema:
type: boolean
default: false
example: true
schemas:
WelcomeMessage:
type: object
properties:
title:
type: string
example: "Welcome to the Home Access Center API!"
message:
type: string
example: "Interactive API documentation available at /docs"
docs_url:
type: string
example: "https://hac.packjack.dev/docs"
openapi_spec:
type: object
properties:
yaml:
type: string
example: "https://hac.packjack.dev/openapi.yaml"
json:
type: string
example: "https://hac.packjack.dev/openapi.json"
routes:
type: array
items:
type: string
example: ["/api/name", "/api/info", "/api/classes"]
cache_param:
type: string
example: "Add ?no_cache=true to any endpoint to bypass cache"
ErrorResponse:
type: object
properties:
error:
type: string
description: Error message describing what went wrong
responses:
Unauthorized:
description: Invalid username or password
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: "Invalid username or password"
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: "Failed to fetch data from Home Access Center"