TLUHK-RIF21 / HK-Ainekursus

http://ainekursus.hk.tlu.ee
0 stars 0 forks source link

Lisada POST http://users.hk.tlu.ee:3333/groups endpoint #52

Closed kaiusk closed 8 months ago

kaiusk commented 8 months ago

Lisada http://users.hk.tlu.ee:3333/groups api'le võimalus lisada uus grupp/kursus. Meie rakendus saadaks uue kursuse õnnestunud lisamisel POST päringu. Päringu sisuks oleks sama JSON struktuur mis GET päringul: "users" oleks tühi array ja "teachers" sisuks oleks see kasutaja, kes kursuse lisas, "id" võime panna "null" (või üldse ära jäta). Vastuseks ootame status=201 (piisab staatuse koodist) või vea korral vea teksti.

Meie rakendus saaks teha esmase valideerimise - st kontrolliks, et sama repo_url'ga pole kursust juba lisatud

mrtrvl commented 8 months ago

Lisatud POST /groups endpoint koos lisamise funktsionaalsusega. https://github.com/tluhk/HK-Users-Service/commit/17322d16e7c57432b1999626c4a85ad390fcb400 Hetkel on ainuke nõutud väli name, kuna võib juhtuda, et on vaja moodustada ka gruppe, mis ei ole otseselt õppeaine muude parameetritega seotud (rühmatööde jaoks näiteks). Vastuvõetavad parameetrid on:

Eduka lisamise puhul tagastatakse staatus 201 ja vastus koos loodud grupi objektiga. Näiteks:

{
  "success": true,
  "message": "Group created",
  "data": {
    "id": 6,
    "name": "Testgrupp",
    "repository": null,
    "code": null,
    "credits": null,
    "form": null,
    "semester": null,
    "users": null,
    "teachers": null
  }
}

Kui lisamisel tekib mingi probleem, siis tagastatakse vastava koodi ja sisuga vastuse objekt.