xdrm-brackets
/
NxTIC
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

module/apiBlueprint retourne le fichier complet (minadd)

This commit is contained in:
xdrm-brackets 2016-06-04 13:56:07 +02:00
parent 21577552d9
commit 2333e4f0d0
1 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
manager/module/module.php
View File

@ -113,14 +113,12 @@
$content .= "API de la plateforme d'étude **NxTIC**, cette documentation présentera toutes les méthodes accessibles depuis la plateforme elle-même et depuis un logiciel tiers.\n"; $content .= "API de la plateforme d'étude **NxTIC**, cette documentation présentera toutes les méthodes accessibles depuis la plateforme elle-même et depuis un logiciel tiers.\n";
$content .= "La plateforme **NxTIC** est une plateforme d'étude sociale développé par Adrien Marquès _(xdrm-brackets)_ pour un laboratoire de sociologie du _CNRS_.\n"; $content .= "La plateforme **NxTIC** est une plateforme d'étude sociale développé par Adrien Marquès _(xdrm-brackets)_ pour un laboratoire de sociologie du _CNRS_.\n";
$content .= "Elle a pour objectif l'acquisition, la visualisation et l'extraction de données relationnelles.\n"; $content .= "Elle a pour objectif l'acquisition, la visualisation et l'extraction de données relationnelles.\n";
$content .= "> Cette plateforme est temporairement hébergée sur https://socioview.xdrm.io/.\n"; $content .= "> Cette plateforme est temporairement hébergée sur https://socioview.xdrm.io/.\n\n";
$content .= "## Structure et fonctionnement\n"; $content .= "## Structure et fonctionnement\n";
$content .= "Le fonctionnement est basé sur une délégation à 2 niveaux : des __modules__ contenant des __méthodes__.\n\n"; $content .= "Le fonctionnement est basé sur une délégation à 2 niveaux : des __modules__ contenant des __méthodes__.\n\n";
$content .= "***\n"; $content .= "***\n\n";
$content .= "### Paramètres\n"; $content .= "### Paramètres\n";
$content .= "Tous les paramètres doivent être envoyés en `multipart/form-data`.\n\n"; $content .= "Tous les paramètres doivent être envoyés en `multipart/form-data`.\n\n";
@ -131,8 +129,7 @@
$content .= "4. Respectant le `type` défini dans la documentation (cf. [Types](#introduction/types-de-donnees)) \n\n"; $content .= "4. Respectant le `type` défini dans la documentation (cf. [Types](#introduction/types-de-donnees)) \n\n";
$content .= "> **Note:** Les `paramètres URI` ne correspondent pas aux paramètres URI. \n"; $content .= "> **Note:** Les `paramètres URI` ne correspondent pas aux paramètres URI. \n";
$content .= "Ils servent à expliciter les paramètres et leurs types, et correspondent aux variables notées `{nomVar}` dans le corps de la requête.\n"; $content .= "Ils servent à expliciter les paramètres et leurs types, et correspondent aux variables notées `{nomVar}` dans le corps de la requête.\n\n";
$content .= "### Réponses\n\n"; $content .= "### Réponses\n\n";
@ -148,8 +145,7 @@
$content .= "|Status|Code HTTP|\n"; $content .= "|Status|Code HTTP|\n";
$content .= "|---|---|\n"; $content .= "|---|---|\n";
$content .= "|OK|`200` - Success|\n"; $content .= "|OK|`200` - Success|\n";
$content .= "|Erreur|`417` - Erreur quelconque|\n"; $content .= "|Erreur|`417` - Erreur quelconque|\n\n";
$content .= "## Types de données\n\n"; $content .= "## Types de données\n\n";
@ -164,7 +160,7 @@
$content .= "|`number`|`0102030405`|Numéro de téléphone valide suivant les formats : `06`, `+336`, `+33 6`|\n"; $content .= "|`number`|`0102030405`|Numéro de téléphone valide suivant les formats : `06`, `+336`, `+33 6`|\n";
$content .= "|`array`|`[1, 3]`|Tableau quelconque non vide|\n"; $content .= "|`array`|`[1, 3]`|Tableau quelconque non vide|\n";
$content .= "|`boolean`|`true`, `false`|Booléen|\n"; $content .= "|`boolean`|`true`, `false`|Booléen|\n";
$content .= "|`varchar(a,b)`|`\"Hello!\"`|Chaine de caractères de taille comprise entre `a` et `b` (inclus)|\n"; $content .= "|`varchar(a,b)`|`\"Hello!\"`|Chaine de caractères de taille comprise entre `a` et `b` (inclus)|\n\n";
$content .= "### Type composé : array\n\n"; $content .= "### Type composé : array\n\n";