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:02:33 +02:00
parent 31667c7bf4
commit 9532240b75
1 changed files with 35 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/api.md
View File

@ -3,8 +3,9 @@
| Api | Zadania tej klasy | | Api | Zadania tej klasy |
| ---------------------------------------------- | ---------------------------------------------------------------- | | ---------------------------------------------- | ---------------------------------------------------------------- |
| [/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 |
## config ## config
@ -14,17 +15,17 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/Conf
POST /config POST /config
``` ```
#### Description #### Opis
Endpoint konfigurujacy caly system i importujacy dane do bazy. Endpoint konfigurujacy caly system i importujacy dane do bazy.
#### Parameters #### Parameters
| Type | Name | Consumes | Description | 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 |
## getCoursesWithGroups ## getcourseswithgroups
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java) Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
@ -32,11 +33,11 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getC
GET /getCoursesWithGroups GET /getCoursesWithGroups
``` ```
#### Description #### Opis
Zwraca wszystkie dostepne kursy wraz z lista grup dla poszczegolnych kursow. 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) Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/GroupController.java)
@ -44,13 +45,37 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/Grou
GET /getCourseGroups GET /getCourseGroups
``` ```
#### Description #### Opis
Endpoint konfigurujacy caly system i importujacy dane do bazy. Endpoint konfigurujacy caly system i importujacy dane do bazy.
#### Parameters #### Parameters
| Type | Name | Consumes | Description | 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 |
## getcourses
Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getCoursesWithGroups.java)
```
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.