90 lines
2.5 KiB
JSON
Executable File
90 lines
2.5 KiB
JSON
Executable File
{
|
|
|
|
"authentication": {
|
|
"POST admin": {
|
|
"description": "Connexion administrateur",
|
|
"permissions": [],
|
|
"parameters": {
|
|
"username": { "description": "Identifiant de l'administrateur.", "type": "varchar(3,20,alphanumeric)" },
|
|
"password": { "description": "Mot de passe de l'administrateur.", "type": "text" }
|
|
},
|
|
"output": {
|
|
"connected": { "description": "Vrai si connecté.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST user": {
|
|
"description": "Connexion utilisateur",
|
|
"permissions": [],
|
|
"parameters": {
|
|
"username": { "description": "Identifiant de l'utilisateur.", "type": "varchar(3,20,alphanumeric)" },
|
|
"password": { "description": "Mot de passe de l'utilisateur'.", "type": "text" }
|
|
},
|
|
"output": {
|
|
"connected": { "description": "Vrai si connecté.", "type": "boolean" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
"RESTexample": {
|
|
"POST article": {
|
|
"description": "Posts a new article",
|
|
"permissions": [["journalist"]],
|
|
"parameters": {
|
|
"title": { "description": "Article's title", "type": "varchar(5,100)" },
|
|
"content": { "description": "Article's content", "type": "text" }
|
|
},
|
|
"output": {
|
|
"created_id": { "description": "Id of the created article", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"GET article": {
|
|
"description": "Gets all or a specific article",
|
|
"permissions": [["viewer"], ["journalist"]],
|
|
"parameters": {
|
|
"URL_0": { "description": "Article id", "type": "id", "optional": true }
|
|
},
|
|
"output": {
|
|
"articles": { "description": "List of selected articles", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"VIEW article": {
|
|
"description": "Gets a specific article into a json file (download)",
|
|
"permissions": [["viewer"], ["journalist"]],
|
|
"options": { "download": true },
|
|
"parameters": {
|
|
"URL_0": { "description": "Article id", "type": "id" }
|
|
},
|
|
"output": {
|
|
"article": { "description": "Selected article as JSON file", "type": "text" }
|
|
}
|
|
},
|
|
|
|
"PUT article": {
|
|
"description": "Updates a specific article",
|
|
"permissions": [["journalist"]],
|
|
"parameters": {
|
|
"URL_0": { "description": "Article id", "type": "id" },
|
|
"content": { "description": "Article's content", "type": "text" }
|
|
},
|
|
"output": {
|
|
"article": { "description": "Returns updated article", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"DELETE article": {
|
|
"description": "Deletes a specific article",
|
|
"permissions": [["journalist"]],
|
|
"parameters": {
|
|
"URL_0": { "description": "Article id", "type": "id" }
|
|
},
|
|
"output": {}
|
|
}
|
|
}
|
|
}
|