filipizydorczyk/backend
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated fix

Browse Source
This commit is contained in:
Marcin Woźniak 2020-08-29 11:56:30 +02:00
parent c64d08a5d2
commit d4abf7e6a4
1 changed files with 10 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/api.md
View File

@ -1,11 +1,11 @@
# Dokumetacja API
| Api | Zadania tej klasy |
| ---------------------------------------------- | ---------------------------------------------------------------- |
| [/config](#config) | Załadowanie konfiguracji startowej do aplikacji PlanNaPlan |
| [/getCoursesWithGroups](#getcourseswithgroups) | Zwrócenie wszytskich kursów (ćwiczenia, wykłady) razem z grupami |
| [/getCourseGroups](#getcoursegroups) | Zwrócenie grup dla danego kursu |
| [/getCourses](#getcourses) | Zwróenie wszystkich kursów |
| Api | Zadania endpointa |
| ---------------------------------------------- | ---------------------------------------------------------- |
| [/config](#config) | Załadowanie konfiguracji startowej do aplikacji PlanNaPlan |
| [/getCoursesWithGroups](#getcourseswithgroups) | Zwrócenie wszytskich kursów razem z grupami |
| [/getCourseGroups](#getcoursegroups) | Zwrócenie grup dla danego kursu |
| [/getCourses](#getcourses) | Zwrócenie wszystkich kursów |
## config
@ -25,7 +25,7 @@ Endpoint konfigurujacy caly system i importujacy dane do bazy.
| ---- | ----------------------- | ------------------- | ------------------------------- | ---- |
| Body | **file** </br> required | multipart/form-data | Plik .xlsx z potrzebnymi danymi | file |
## getcourseswithgroups
## getCoursesWithGroups
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
@ -37,7 +37,7 @@ GET /getCoursesWithGroups
Zwraca wszystkie dostepne kursy wraz z lista grup dla poszczegolnych kursow.
## getcoursegroups
## getCourseGroups
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/GroupController.java)
@ -56,9 +56,9 @@ Endpoint konfigurujacy caly system i importujacy dane do bazy.
| Query Param | **id** </br> required | - | id kursu dla ktorego chcemy zwrocic grupy | int |
| Query Param | **capacity** </br> | - | czy ma zwrocic pole pojemnosci grupy | bool |
## getcourses
## getCourses
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/CoursesController.java)
```
GET /getCourses
@ -67,15 +67,3 @@ GET /getCourses
#### Opis
Zwraca wszystkie dostepne kursy.
## getCourseGroups
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/GroupController.java)
```
GET /getCourse
```
#### Opis
Endpoint konfigurujacy caly system i importujacy dane do bazy.