dodokpeter / reality-estate

0 stars 1 forks source link

Design API - POST /realities/{realityId} #9

Open dodokpeter opened 2 months ago

dodokpeter commented 2 months ago

Popis API endpoint POST /realities/{realityId} slúži na aktualizáciu detailov existujúcej nehnuteľnosti na základe jej unikátneho identifikátora. Ak je realityId prázdne (null), vytvorí sa nový záznam nehnuteľnosti.

Požiadavky Metóda: POST Cesta: /realities/{realityId}

Parametre realityId (nepovinné): Unikátny identifikátor nehnuteľnosti, ktorú chcete aktualizovať. Ak je realityId prázdne (null), vytvorí sa nový záznam.

Telo žiadosti (Request Body) Telo žiadosti by malo byť vo formáte JSON a môže obsahovať nasledujúce polia:

{
  "type": "byt", // Typ nehnuteľnosti (povinné)
  "location": "Bratislava", // Lokalita nehnuteľnosti (povinné, nesmie byť prázdny reťazec)
  "price": 160000, // Cena nehnuteľnosti v eurách (povinné, musí byť >= 1000)
  "rooms": 3, // Počet izieb (povinné)
  "area": 75, // Rozloha nehnuteľnosti v m² (povinné)
  "description": "Zrekonštruovaný 3-izbový byt v centre mesta.", // Krátky popis nehnuteľnosti (voliteľné, max. 500 znakov)
  "images": [ // Pole URL obrázkov nehnuteľnosti (voliteľné)
    "https://priklad.sk/obrazok1.jpg",
    "https://priklad.sk/obrazok2.jpg"
  ]
}

Odpoveď Kód 200 OK: Úspešná odpoveď vráti aktualizované detaily nehnuteľnosti vo formáte JSON (ak realityId existuje). Kód 201 Created: Úspešná odpoveď pri vytvorení nového záznamu nehnuteľnosti vráti detaily novo vytvorenej nehnuteľnosti vo formáte JSON (ak realityId je prázdne).

Chybové kódy 404 Not Found: Nehnuteľnosť s daným realityId nebola nájdená (pri pokuse o aktualizáciu). 400 Bad Request: Neplatné údaje v tele žiadosti. 500 Internal Server Error: Chyba na strane servera pri aktualizácii alebo vytváraní nehnuteľnosti.

seidlmatus commented 1 month ago

pridat aspon 1 succes test na api, cez wiremock