ptut-vhost/config/modules.json

127 lines
2.6 KiB
JSON
Raw Normal View History

2018-02-17 17:18:58 +00:00
{
2018-02-17 18:01:17 +00:00
"GET": {
"des": "Returns the API documentation",
"per": [],
"par": {
"URL0": { "des": "Method name", "typ": "varchar(1,30)", "ren": "method_name", "opt": true, "def": null }
}
},
2018-02-17 17:18:58 +00:00
2018-02-17 18:01:17 +00:00
"admin": {
2018-02-17 17:18:58 +00:00
"POST": {
2018-02-17 18:01:17 +00:00
"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" }
2018-02-17 17:18:58 +00:00
}
},
2018-02-17 18:01:17 +00:00
"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 }
2018-02-17 17:18:58 +00:00
}
},
2018-02-17 18:01:17 +00:00
"DELETE": {
"des": "Deletes an administrator",
"per": [["admin"]],
"par": {
"URL0": { "des": "The UID of the wanted administrator.", "typ": "id", "opt": true, "ren": "id_admin" }
2018-02-17 17:18:58 +00:00
}
},
2018-02-17 18:01:17 +00:00
"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" }
2018-02-17 17:18:58 +00:00
}
}
},
2018-02-17 18:01:17 +00:00
"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 }
}
}
},
"Excel":{
"POST": {
"des": "Import data from an Excel file",
"per": [],
"par": {
}
}
},
"Professor":{
"Stats": {
"GET":{
"des": "Get statistics of the professor",
"per": [],
"par":{
"URL0": {"des" : "Id of the professor", "typ": "id", "ren": "idProf", "opt" : false}
}
}
}
},
2018-02-17 18:01:17 +00:00
"a": {
"b": {
2018-02-17 17:18:58 +00:00
2018-02-17 18:01:17 +00:00
"c": {
"PUT": {
"des": "PUT A/B/C.",
"per": [],
"par": {}
},
"DELETE": {
"des": "DELETE A/B/C.",
"per": [],
"par": {}
2018-02-17 17:18:58 +00:00
}
2018-02-17 18:01:17 +00:00
},
"PUT": {
"des": "PUT A/B.",
"per": [],
"par": {}
},
"DELETE": {
"des": "DELETE A/B.",
"per": [],
"par": {}
2018-02-17 17:18:58 +00:00
}
2018-02-17 18:01:17 +00:00
},
"GET": {
"des": "GET A.",
"per": [],
"par": {}
},
"POST": {
"des": "POST A.",
"per": [],
"par": {}
2018-02-17 17:18:58 +00:00
}
}
2018-02-17 18:01:17 +00:00
}