Migrace klienta na OpenAPI

types/paths/easterEggs/easterEgg.yml

@@ -0,0 +1,18 @@
+get:
+  operationId: getEasterEggImage
+  summary: Vrátí obrázek konkrétního easter eggu
+  parameters:
+    - in: path
+      name: url
+      required: true
+      schema:
+        type: string
+      description: URL easter eggu
+  responses:
+    "200":
+      content:
+        image/png:
+          description: Obrázek easter eggu
+          schema:
+            type: string
+            format: binary

types/paths/easterEggs/easterEggs.yml

@@ -0,0 +1,9 @@
+get:
+  operationId: getEasterEgg
+  summary: Vrátí náhodně metadata jednoho z definovaných easter egg obrázků pro přihlášeného uživatele, nebo nic, pokud žádné definované nemá.
+  responses:
+    "200":
+      content:
+        application/json:
+          schema:
+            $ref: "../../schemas/_index.yml#/EasterEgg"

types/paths/food/addChoice.yml

@@ -0,0 +1,20 @@
+post:
+  operationId: addChoice
+  summary: Přidání či nahrazení volby uživatele pro zvolený den/podnik
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - locationKey
+          properties:
+            locationKey:
+              $ref: "../../schemas/_index.yml#/LunchChoice"
+            dayIndex:
+              $ref: "../../schemas/_index.yml#/DayIndex"
+            foodIndex:
+              $ref: "../../schemas/_index.yml#/FoodIndex"
+  responses:
+    "200":
+      $ref: "../../api.yml#/components/responses/ClientDataResponse"

types/paths/food/changeDepartureTime.yml

@@ -0,0 +1,16 @@
+post:
+  operationId: changeDepartureTime
+  summary: Úprava preferovaného času odchodu do aktuálně zvoleného podniku.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          properties:
+            dayIndex:
+              $ref: "../../schemas/_index.yml#/DayIndex"
+            time:
+              $ref: "../../schemas/_index.yml#/DepartureTime"
+  responses:
+    "200":
+      $ref: "../../api.yml#/components/responses/ClientDataResponse"

types/paths/food/jdemeObed.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: jdemeObed
+  summary: Odeslání notifikací "jdeme na oběd" dle konfigurace.
+  responses:
+    "200":
+      description: Notifikace byly odeslány.

types/paths/food/removeChoice.yml

@@ -0,0 +1,21 @@
+post:
+  operationId: removeChoice
+  summary: Odstranění jednoho zvoleného jídla uživatele pro zvolený den/podnik
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - foodIndex
+            - locationKey
+          properties:
+            foodIndex:
+              $ref: "../../schemas/_index.yml#/FoodIndex"
+            locationKey:
+              $ref: "../../schemas/_index.yml#/LunchChoice"
+            dayIndex:
+              $ref: "../../schemas/_index.yml#/DayIndex"
+  responses:
+    "200":
+      $ref: "../../api.yml#/components/responses/ClientDataResponse"

types/paths/food/removeChoices.yml

@@ -0,0 +1,18 @@
+post:
+  operationId: removeChoices
+  summary: Odstranění volby uživatele pro zvolený den/podnik, včetně případných jídel
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - locationKey
+          properties:
+            locationKey:
+              $ref: "../../schemas/_index.yml#/LunchChoice"
+            dayIndex:
+              $ref: "../../schemas/_index.yml#/DayIndex"
+  responses:
+    "200":
+      $ref: "../../api.yml#/components/responses/ClientDataResponse"

types/paths/food/updateNote.yml

@@ -0,0 +1,16 @@
+post:
+  operationId: updateNote
+  summary: Nastavení poznámky k volbě uživatele
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          properties:
+            dayIndex:
+              $ref: "../../schemas/_index.yml#/DayIndex"
+            note:
+              type: string
+  responses:
+    "200":
+      $ref: "../../api.yml#/components/responses/ClientDataResponse"

types/paths/getData.yml

@@ -0,0 +1,14 @@
+get:
+  operationId: getData
+  summary: Načtení klientských dat pro aktuální nebo předaný den
+  parameters:
+    - in: query
+      name: dayIndex
+      description: Index dne v týdnu. Pokud není předán, je použit aktuální den.
+      schema:
+        type: integer
+        minimum: 0
+        maximum: 4
+  responses:
+    "200":
+      $ref: "../api.yml#/components/responses/ClientDataResponse"

types/paths/getPizzaQr.yml

@@ -0,0 +1,19 @@
+get:
+  operationId: getPizzaQr
+  summary: Získání QR kódu pro platbu za Pizza day
+  security: [] # Nevyžaduje autentizaci
+  parameters:
+    - in: query
+      name: login
+      schema:
+        type: string
+      required: true
+      description: Přihlašovací jméno uživatele, pro kterého bude vrácen QR kód
+  responses:
+    "200":
+      description: Vygenerovaný QR kód pro platbu
+      content:
+        image/png:
+          schema:
+            type: string
+            format: binary

types/paths/login.yml

@@ -0,0 +1,20 @@
+post:
+  operationId: login
+  summary: Přihlášení uživatele
+  security: [] # Nevyžaduje autentizaci
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            login:
+              type: string
+              description: Přihlašovací jméno uživatele. Vyžadováno pouze pokud není předáno pomocí hlaviček.
+  responses:
+    "200":
+      description: Přihlášení bylo úspěšné
+      content:
+        application/json:
+          schema:
+            $ref: "../schemas/_index.yml#/JWTToken"

types/paths/pizzaDay/addPizza.yml

@@ -0,0 +1,21 @@
+post:
+  operationId: addPizza
+  summary: Přidání pizzy do objednávky.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - pizzaIndex
+            - pizzaSizeIndex
+          properties:
+            pizzaIndex:
+              description: Index pizzy v nabídce
+              type: integer
+            pizzaSizeIndex:
+              description: Index velikosti pizzy v nabídce variant
+              type: integer
+  responses:
+    "200":
+      description: Přidání pizzy do objednávky proběhlo úspěšně.

types/paths/pizzaDay/create.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: createPizzaDay
+  summary: Založení pizza day.
+  responses:
+    "200":
+      description: Pizza day byl založen.

types/paths/pizzaDay/delete.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: deletePizzaDay
+  summary: Smazání pizza day.
+  responses:
+    "200":
+      description: Pizza day byl smazán.

types/paths/pizzaDay/finishDelivery.yml

@@ -0,0 +1,18 @@
+post:
+  operationId: finishDelivery
+  summary: Převod pizza day do stavu "Pizzy byly doručeny". Pokud má objednávající nastaveno číslo účtu, je ostatním uživatelům vygenerován a následně zobrazen QR kód pro úhradu jejich objednávky.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          properties:
+            bankAccount:
+              description: Číslo bankovního účtu objednávajícího
+              type: string
+            bankAccountHolder:
+              description: Jméno majitele bankovního účtu
+              type: string
+  responses:
+    "200":
+      description: Pizza day byl přepnut do stavu "Pizzy doručeny".

types/paths/pizzaDay/finishOrder.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: finishOrder
+  summary: Přepnutí pizza day do stavu "Pizzy objednány". Není možné měnit objednávky, příslušným uživatelům je odeslána notifikace o provedené objednávce.
+  responses:
+    "200":
+      description: Pizza day byl přepnut do stavu "Pizzy objednány".

types/paths/pizzaDay/lock.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: lockPizzaDay
+  summary: Uzamkne pizza day. Nebude možné přidávat či odebírat pizzy.
+  responses:
+    "200":
+      description: Pizza day byl uzamčen.

types/paths/pizzaDay/removePizza.yml

@@ -0,0 +1,16 @@
+post:
+  operationId: removePizza
+  summary: Odstranění pizzy z objednávky.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - pizzaOrder
+          properties:
+            pizzaOrder:
+              $ref: "../../schemas/_index.yml#/PizzaVariant"
+  responses:
+    "200":
+      description: Odstranění pizzy z objednávky proběhlo úspěšně.

types/paths/pizzaDay/unlock.yml

@@ -0,0 +1,6 @@
+post:
+  operationId: unlockPizzaDay
+  summary: Odemkne pizza day. Bude opět možné přidávat či odebírat pizzy.
+  responses:
+    "200":
+      description: Pizza day byl odemčen.

types/paths/pizzaDay/updatePizzaDayNote.yml

@@ -0,0 +1,15 @@
+post:
+  operationId: updatePizzaDayNote
+  summary: Nastavení poznámky k objednávkám pizz přihlášeného uživatele.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          properties:
+            note:
+              type: string
+              description: Poznámka k objednávkám pizz, např "bez oliv".
+  responses:
+    "200":
+      description: Nastavení poznámky k objednávkám pizz proběhlo úspěšně.

types/paths/pizzaDay/updatePizzaFee.yml

@@ -0,0 +1,23 @@
+post:
+  operationId: updatePizzaFee
+  summary: Nastavení přirážky/slevy k objednávce pizz uživatele.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          required:
+            - login
+          properties:
+            login:
+              type: string
+              description: Login cíleného uživatele
+            text:
+              type: string
+              description: Textový popis přirážky/slevy
+            price:
+              type: number
+              description: Částka přirážky/slevy v Kč
+  responses:
+    "200":
+      description: Nastavení přirážky/slevy proběhlo úspěšně.

types/paths/stats/stats.yml

@@ -0,0 +1,23 @@
+get:
+  operationId: getStats
+  summary: Vrátí statistiky způsobu stravování pro předaný rozsah dat.
+  parameters:
+    - in: query
+      name: startDate
+      required: true
+      schema:
+        type: string
+      description: Počáteční datum pro načtení statistik
+    - in: query
+      name: endDate
+      required: true
+      schema:
+        type: string
+      description: Koncové datum pro načtení statistik
+  responses:
+    "200":
+      description: Statistiky způsobu stravování. Každý prvek v poli představuje statistiky pro jeden den z předaného rozsahu dat.
+      content:
+        application/json:
+          schema:
+            $ref: "../../schemas/_index.yml#/WeeklyStats"

types/paths/voting/getVotes.yml

@@ -0,0 +1,11 @@
+get:
+  operationId: getVotes
+  summary: Vrátí statistiky hlasování o nových funkcích.
+  responses:
+    "200":
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: "../../schemas/_index.yml#/FeatureRequest"

types/paths/voting/updateVote.yml

@@ -0,0 +1,19 @@
+post:
+  operationId: updateVote
+  summary: Aktualizuje hlasování uživatele o dané funkcionalitě.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            option:
+              description: Hlasovací možnost, kterou uživatel zvolil.
+              $ref: "../../schemas/_index.yml#/FeatureRequest"
+            active:
+              type: boolean
+              description: True, pokud uživatel hlasoval pro, jinak false.
+  responses:
+    "200":
+      description: Hlasování bylo úspěšně aktualizováno.