NxTIC/config/modules.json

{
	"module": {
		"method": {
			"description": "Test de l'API",
			"permissions": [],
			"parameters": {}
		},

		"phpunitParams": {
			"description": "Méthode utile à phpunit pour le test des paramètres.",
			"permissions": [],
			"parameters": {
				"p1": { "description": "Texte", "type": "text" },
				"p2": { "description": "Entier positif", "type": "id" }
			},
			"output": {
				"receivedArguments": { "description": "Liste des arguments reçus par la méthode", "type": "array<mixed>" }
			}
		},

		"phpunitOptionalParams": {
			"description": "Méthode utile à phpunit pour le test des paramètres optionnels.",
			"permissions": [],
			"parameters": {
				"p1": { "description": "Texte", "type": "text"                                      },
				"p2": { "description": "Texte", "type": "text", "optional": false                   },
				"p3": { "description": "Entier positif (optionnel)", "type": "id", "optional": true }
			}
		},

		"phpunitPermissions": {
			"description": "Méthode utile à phpunit pour le test des permissions.",
			"permissions": ["a", "b"],
			"parameters": {}
		},


		"markdown": {
			"description": "Retourne une description en markdown des différents modules de l'API",
			"permissions": [],
			"options": { "download": true },
			"parameters": {}
		},


		"apiBlueprint": {
			"description": "Retourne une documentation de l'API au format API Blueprint.",
			"permissions": [],
			"options": { "download": true },
			"parameters": {}
		}
	},

	"user": {
		"login": {
			"description": "Connexion avec un login (identifiant ou adresse mail) et un mot de passe.",
			"permissions": [],
			"parameters": {
				"login":    { "description": "Identifiant ou adresse mail", "type": "varchar(3,50)" },
				"password": { "description": "Mot de passe",                "type": "text"          }
			},
			"output": {
				"id_user": { "description": "Identifiant de l'utilisateur connecté", "type": "id" }
			}
		},

		"logout": {
			"description": "Deconnexion",
			"permissions": ["admin"],
			"parameters": {}
		},


		"getById": {
			"description": "Retourne les informations d'un utilisateur.",
			"permissions": ["admin"],
			"parameters":  {
				"id_user": { "description": "UID de l'utilisateur recherche.", "type": "id" }
			},
			"output": {
				"user": { "description": "Propriétés de l'utilisateur en question.", "type": "array<mixed>" }
			}
		},


		"getAll": {
			"description": "Retourne les informations de tous les utilisateurs.",
			"permissions": ["admin"],
			"parameters": {},
			"output": {
				"users": { "description": "Propriétés de tous les utilisateurs existants.", "type": "array<array<mixed>>" }
			}
		},


		"create": {
			"description": "Creation d'un nouvel administrateur.",
			"permissions": ["admin"],
			"parameters": {
				"login":      { "description": "Login de l'administrateur, 30 caracteres maximum.",   "type": "varchar(3,30)" },
				"password":   { "description": "Mot de passe de l'administrateur.",                   "type": "text"          },
				"mail":       { "description": "Adresse mail de l'administrateur.",                   "type": "mail"          }
			},
			"output": {
				"id_user": { "description": "Identifiant de l'administrateur créé", "type": "id" }
			}
		},


		"remove": {
			"description": "Suppression d'un utilisateur.",
			"permissions": ["admin"],
			"parameters": {
				"id_user": { "description": "UID de l'utilisateur", "type": "id" }
			}
		}

	},

	"token": {

		"remove": {
			"description": "Suppression d'un token d'id donne.",
			"permissions": ["admin"],
			"parameters": {
				"token_id": { "description": "UID du token a supprimer", "type": "id" }
			}
		},


		"generate": {
			"description": "Création d'un token de nom et de durée donnée",
			"permissions": ["admin"],
			"parameters": {
				"name":     { "description": "Nom attribué au token", "type": "varchar(3,50)" },
				"duration": { "description": "Durée du token en nombre de jours", "type": "id" }
			},
			"output": {
				"id_token": { "description": "Identifiant du token généré", "type": "id" }
			}
		}
	},

	"subject": {

		"search": {
			"description": "Recherche d'un sujet par nom",
			"permissions": ["admin"],
			"parameters": {
				"name": { "description": "Le nom du sujet", "type": "varchar(1,50)" }
			},
			"output": {
				"results": { "description": "Liste des sujet associés aux mots-clés.", "type": "array<array<mixed>>" }
			}
		},

		"getFriends": {
			"description": "Retourne les informations de tous les contacts renseignés par un sujet d'enquête.",
			"permissions": ["admin"],
			"parameters": {
				"subject_id": { "description": "Identifiant du sujet duquel on veut les amis.", "type": "id" }
			},
			"output": {
				"subjects": { "description": "Liste des sujet renseignés par le sujet donné.", "type": "array<array<mixed>>" }
			}
		},

		"getAll": {
			"description": "Retourne les informations de tous les sujets.",
			"permissions": ["admin"],
			"parameters": {},
			"output": {
				"subjects": { "description": "Liste de tous les sujet.", "type": "array<array<mixed>>" }
			}
		},


		"create": {
			"description": "Creation d'un nouveau sujet.",
			"permissions": ["admin"],
			"parameters": {
				"name" : { "description": "Pseudo du sujet, 50 caracteres maximum.",   "type": "varchar(1,50)" }
			},
			"output": {
				"id_subject": { "description": "Identifiant du sujet créé.", "type": "id" }
			}
		}

	},

	"input": {

		"phone": {
			"description": "Enregistre les données d'une enquête téléphonique.",
			"permissions": ["admin"],
			"parameters": {
				"subject":  { "description": "Données sur le sujet de l'enquête.",                              "type": "array"                          },
				"contacts": { "description": "Données des contacts de l'enquête.",                              "type": "array<array>"                   },
				"mini":     { "description": "Mini fiches relations sur les contacts de l'enquête.",            "type": "array<array>"                   },
				"fiches":   { "description": "Fiches relation sur les plus proches contacts de l'enquête.",     "type": "array<array>"                   },
				"matrice":  { "description": "Matrice contenant les relations entre les plus proches contacts", "type": "array<array>", "optional": true }
			},
			"output": {
				"subject_id": { "description": "Identifiant du sujet complété", "type": "id" }
			}
		},

		"facebook": {
			"description": "Enregistre les données d'une enquête facebook.",
			"permissions": ["admin"],
			"parameters": {
				"subject":  { "description": "Données sur le sujet de l'enquête.",                              "type": "array"                          },
				"contacts": { "description": "Données des contacts de l'enquête.",                              "type": "array<array>"                   },
				"mini":     { "description": "Mini fiches relations sur les contacts de l'enquête.",            "type": "array<array>"                   },
				"fiches":   { "description": "Fiches relation sur les plus proches contacts de l'enquête.",     "type": "array<array>"                   },
				"matrice":  { "description": "Matrice contenant les relations entre les plus proches contacts", "type": "array<array>", "optional": true }
			},
			"output": {
				"subject_id": { "description": "Identifiant du sujet complété", "type": "id" }
			}
		}
	},


	"upload": {

		"local_data": {
			"description": "Upload d'une sauvegarde de formulaire local au format .json.",
			"permissions": ["admin"],
			"parameters": {
				"file": { "description": "Fichier du de sauvegarde de formulaire local.", "type": "FILE" }
			},
			"output": {
				"local_data": { "description": "Contenu formatté du fichier.", "type": "array<mixed>"}
			}
		}

	},


	"download": {

		"multiple": {
			"description": "Download des données relatives aux sujets donnés.",
			"permissions": ["admin"],
			"options": { "download": true },
			"parameters": {
				"subjects": { "description": "Identifiants des sujets d'enquêtes à intégrer.",     "type": "array<id>", "optional": true },
				"phone":    { "description": "Si vaut TRUE, renvoie les sujets cellulaires.",      "type": "boolean",   "optional": true },
				"facebook": { "description": "Si vaut TRUE, renvoie les sujet facebook.",          "type": "boolean",   "optional": true },
				"survey":   { "description": "Si vaut TRUE, renvoie les sujets ResTIC.",           "type": "boolean",   "optional": true },
				"all":      { "description": "Si vaut TRUE, renvoie tous les sujets enregistrés.", "type": "boolean",   "optional": true }
			}
		},

		"chart": {
			"description": "Download des données relatives aux sujets donnés sur le principe noeuds+liens.",
			"permissions": ["admin"],
			"options": { "download": true },
			"parameters": {
				"subjects": { "description": "Identifiants des sujets d'enquêtes à intégrer.",     "type": "array<id>", "optional": true },
				"phone":    { "description": "Si vaut TRUE, renvoie les sujets cellulaires.",      "type": "boolean",   "optional": true },
				"facebook": { "description": "Si vaut TRUE, renvoie les sujet facebook.",          "type": "boolean",   "optional": true },
				"survey":   { "description": "Si vaut TRUE, renvoie les sujets ResTIC.",           "type": "boolean",   "optional": true },
				"all":      { "description": "Si vaut TRUE, renvoie tous les sujets enregistrés.", "type": "boolean",   "optional": true }
			}
		},

		"menu": {
			"description": "Contenu de la configuration du menu.",
			"permissions": ["admin"],
			"parameters": {},
			"output": {
				"menu": { "description": "Contenu formatté de la configuration du menu.", "type": "array<mixed>" }
			}
		}
	}
}