From 9532240b75c57f3764968c64b2872f7e11c7d7b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wo=C5=BAniak?= Date: Fri, 28 Aug 2020 16:02:33 +0200 Subject: [PATCH] Auto-commit: saved api.md --- docs/api.md | 45 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/docs/api.md b/docs/api.md index 260b179..33be0fd 100644 --- a/docs/api.md +++ b/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**
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**
required | - | id kursu dla ktorego chcemy zwrocic grupy | int | | Query Param | **capacity**
| - | 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.