API - Profile & Packages

[dunaevskiy]

🌏 User Profile

• [ ] Editace uzivatelskeho jmena a e-mailu

Client: Vzdy posila pouze ten udaj, ktery zmenil uzivatel (input polozky neni prazdny).

{
  "username": "username",
  "email" : "email@email.com",
  "token" : "token"
}

Server:

// 200
"success"
// 400
"username is not unique"
"email is not unique"

🌏 Packages

• [ ] Hledani package v registru podle jmena

Client:

// name je array vzdy s jednou polozkou (myslime na budoucnost a tagy, ze jo)
{
  "name": ["packageName"],
  "token" : "token"
}

Server:

// 200
[
  {
    "uniqueId" : "256",
    "name": "packageName",
    "version": "v1.0.0",
    "description": "optional description",
    "state": "deprecated"
  }
]

• [ ] Pridani package do registru

Client:

{
  "repository": "https://github.com/evo-doc/evodoc-license-mit",
  "token" : "token"
}

Server:

// 200
{
  "uniqueId" : "256",
}
// 400
"some kind of error"

• [ ] Detailni informace o package

Client: uniqueId se bude brat ze seznamu packages, kdyz je napriklad hledam, viz Hledani package v registru podle jmena

{
  "uniqueId": "256",
  "token" : "token"
}

Server: Nejspis bude vracet cely evodoc.json z repozitare. Aktualne to muzeme nejak omezit na jmeno a neco jeste, nevim, je to jedno.

// 200
{
  "uniqueId" : "256",
  "name": "packageName",
  "version": "v1.0.0",
  "description": "optional description",
  "state": "deprecated"
}
// 400
"package does not exist"

• [ ] Prevadeni pacakge do deprecated stavu a zpet

Client:

{
  "uniqueId": "256",
  "token" : "token"
}

Server:

// 200
{
  "state": "deprecated (OR) active"
}

// 400
"you are not package owner"
"package does not exist"

• [ ] Vratit package pridane jednim uzivatelem

Client:

{
  "user_id": "457",
  "token" : "token"
}

Server:

// 200
[
  {
    "uniqueId" : "256",
    "name": "packageName",
    "version": "v1.0.0",
    "description": "optional description",
    "state": "deprecated"
  }
]

//400
"user does not exist"

[TomStary]

User už akci edit má, url: /users method: POST, všechny parametry krom user_id a token jsou nepovinné. Dokonce je to na apiari, pouze upravíme hlášky asi pokud teda budeš chtít.