Auto-commit: saved api.md
This commit is contained in:
parent
31667c7bf4
commit
9532240b75
45
docs/api.md
45
docs/api.md
@ -1,10 +1,11 @@
|
||||
# Dokumetacja API
|
||||
|
||||
| Api | Zadania tej klasy |
|
||||
| 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 |
|
||||
| [/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 |
|
||||
|
||||
## config
|
||||
|
||||
@ -14,17 +15,17 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/Conf
|
||||
POST /config
|
||||
```
|
||||
|
||||
#### Description
|
||||
#### Opis
|
||||
|
||||
Endpoint konfigurujacy caly system i importujacy dane do bazy.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Type | Name | Consumes | Description | Type |
|
||||
| Type | Name | Consumes | Opis | Type |
|
||||
| ---- | ----------------------- | ------------------- | ------------------------------- | ---- |
|
||||
| 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)
|
||||
|
||||
@ -32,11 +33,11 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/getC
|
||||
GET /getCoursesWithGroups
|
||||
```
|
||||
|
||||
#### Description
|
||||
#### Opis
|
||||
|
||||
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)
|
||||
|
||||
@ -44,13 +45,37 @@ Source code: [link](../restservice/src/main/java/com/plannaplan/controllers/Grou
|
||||
GET /getCourseGroups
|
||||
```
|
||||
|
||||
#### Description
|
||||
#### Opis
|
||||
|
||||
Endpoint konfigurujacy caly system i importujacy dane do bazy.
|
||||
|
||||
#### 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 | **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.
|
||||
|
Loading…
Reference in New Issue
Block a user