107 lines
2.3 KiB
JSON
Executable File
107 lines
2.3 KiB
JSON
Executable File
{
|
|
"GET": {
|
|
"des": "Returns the API documentation",
|
|
"per": [],
|
|
"par": {
|
|
"URL0": { "des": "Method name", "typ": "varchar(1,30)", "ren": "method_name", "opt": true, "def": null }
|
|
}
|
|
},
|
|
|
|
"admin": {
|
|
|
|
"POST": {
|
|
"des": "Creates a new administrator",
|
|
"per": [["admin"]],
|
|
"par": {
|
|
"username": { "des": "The new administrator username", "typ": "varchar(3,20,alphanumeric)" },
|
|
"mail": { "des": "The new administrator email address", "typ": "mail" },
|
|
"password": { "des": "The new administrator passowrd", "typ": "text" }
|
|
}
|
|
},
|
|
|
|
"PUT": {
|
|
"des": "Updates an existing administrator's data",
|
|
"per": [["admin"]],
|
|
"par": {
|
|
"URL0": { "des": "The UID of the wanted administrator.", "typ": "id", "ren": "id_admin" },
|
|
"mail": { "des": "The new administrator email address", "typ": "mail", "opt": true },
|
|
"password": { "des": "The new administrator passowrd", "typ": "text", "opt": true }
|
|
}
|
|
},
|
|
|
|
"DELETE": {
|
|
"des": "Deletes an administrator",
|
|
"per": [["admin"]],
|
|
"par": {
|
|
"URL0": { "des": "The UID of the wanted administrator.", "typ": "id", "opt": true, "ren": "id_admin" }
|
|
}
|
|
},
|
|
|
|
"GET": {
|
|
"des": "Gets an administrator | Gets all administrators if no id defined",
|
|
"per": [["admin"]],
|
|
"par": {
|
|
"URL0": { "des": "The UID of the wanted administrator.", "typ": "id", "opt": true, "ren": "id_admin" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
"release": {
|
|
|
|
"GET": {
|
|
|
|
"des": "Pulls project from git branch.",
|
|
"per": [["admin"]],
|
|
"par": {
|
|
"URL0": { "des": "Name of the project to release", "typ": "alphanumeric", "ren": "project", "opt": true, "def": "self" },
|
|
"URL1": { "des": "Step to run, if not given, all steps will be run", "typ": "id", "ren": "step", "opt": true }
|
|
}
|
|
|
|
}
|
|
},
|
|
|
|
"a": {
|
|
|
|
"b": {
|
|
|
|
"c": {
|
|
"PUT": {
|
|
"des": "PUT A/B/C.",
|
|
"per": [],
|
|
"par": {}
|
|
},
|
|
"DELETE": {
|
|
"des": "DELETE A/B/C.",
|
|
"per": [],
|
|
"par": {}
|
|
}
|
|
|
|
},
|
|
|
|
"PUT": {
|
|
"des": "PUT A/B.",
|
|
"per": [],
|
|
"par": {}
|
|
},
|
|
"DELETE": {
|
|
"des": "DELETE A/B.",
|
|
"per": [],
|
|
"par": {}
|
|
}
|
|
|
|
},
|
|
|
|
"GET": {
|
|
"des": "GET A.",
|
|
"per": [],
|
|
"par": {}
|
|
},
|
|
"POST": {
|
|
"des": "POST A.",
|
|
"per": [],
|
|
"par": {}
|
|
}
|
|
}
|
|
}
|