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

Auto-commit: saved api.md

Browse Source
This commit is contained in:
Marcin Woźniak 2020-08-28 16:09:44 +02:00
parent 8bc2ba4d34
commit f05666d688
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.md
View File

@ -5,7 +5,7 @@
| [/config](#config) | Załadowanie konfiguracji startowej do aplikacji PlanNaPlan | | [/config](#config) | Załadowanie konfiguracji startowej do aplikacji PlanNaPlan |
| [/getCoursesWithGroups](#getcourseswithgroups) | Zwrócenie wszytskich kursów (ćwiczenia, wykłady) razem z grupami | | [/getCoursesWithGroups](#getcourseswithgroups) | Zwrócenie wszytskich kursów (ćwiczenia, wykłady) razem z grupami |
| [/getCourseGroups](#getcoursegroups) | Zwrócenie grup dla danego kursu | | [/getCourseGroups](#getcoursegroups) | Zwrócenie grup dla danego kursu |
| [/getCourses](#getcourses) | Zwróenie wszystkich kursów | | [/getCourses](#getcourses) | Zwróenie wszystkich kursów |
## config ## config
@ -21,7 +21,7 @@ Endpoint konfigurujacy caly system i importujacy dane do bazy.
#### Parametry #### Parametry
| Type | Name | Consumes | Opis | Type | | Type | Name | Consumes | Opis | Type |
| ---- | ----------------------- | ------------------- | ------------------------------- | ---- | | ---- | ----------------------- | ------------------- | ------------------------------- | ---- |
| Body | **file** </br> required | multipart/form-data | Plik .xlsx z potrzebnymi danymi | file | | Body | **file** </br> required | multipart/form-data | Plik .xlsx z potrzebnymi danymi | file |
@ -51,7 +51,7 @@ Endpoint konfigurujacy caly system i importujacy dane do bazy.
#### Parametry #### Parametry
| Type | Name | Consumes | Opis | Type | | Type | Name | Consumes | Opis | Type |
| ----------- | --------------------- | -------- | ----------------------------------------- | ---- | | ----------- | --------------------- | -------- | ----------------------------------------- | ---- |
| Query Param | **id** </br> required | - | id kursu dla ktorego chcemy zwrocic grupy | int | | Query Param | **id** </br> required | - | id kursu dla ktorego chcemy zwrocic grupy | int |
| Query Param | **capacity** </br> | - | czy ma zwrocic pole pojemnosci grupy | bool | | Query Param | **capacity** </br> | - | czy ma zwrocic pole pojemnosci grupy | bool |