Skip to content

Commit 27e8258

Browse files
authored
doc: add supported routes in README.md (#45)
1 parent 3958e8f commit 27e8258

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
<h5 align="center"> Unofficial API for the timetable of Lahore Garrison University. </h5>
44

55
### Routes
6-
All Routes requires these parameters: `session`, `semester`, `degree`, `section`
7-
| Route | Special Params | Description |
8-
|----------------------------|:------------:|:----------------|
9-
| `/` | _ | Fetch the timetable from `timetable.lgu.edu.pk` and return it in **JSON format**|
10-
| `/gc-integration` | _ | Create events on google calendar based on the official timetable. |
6+
| Route | Special Params | Description | Example |
7+
|----------------------------|:--------------------------:|:------------------------------------------------------:|---------------------------|
8+
| GET `/semesters` | _ | return a **JSON** Object containing semesters. | [See Example](https://lgu-timetable-api.deta.dev/semesters)|
9+
| GET `/degrees` | `semester` | all the degree programs in a specific semester. | [See Example](https://lgu-timetable-api.deta.dev/degrees?semester=5)|
10+
| GET `/sections` | `semester`,`degree` | all the section in a semester with via degree program. | [See Example](https://lgu-timetable-api.deta.dev/sections?semester=1&degree=BSCS)|
11+
| GET `/timetable` | `semester`, `degree`, `section` | all the degree programs in a specific semester.| [See Example](https://lgu-timetable-api.deta.dev/timetable?semester=3&degree=BSCS&section=A)|
1112

1213
<br>
1314

0 commit comments

Comments
 (0)