api.extractFromLex
Récupère un nombre n de graphies d’un lexique ou d'une liste. Les réinjecte dans un lexique si spécifié.
Use cases
Permet de :
- créer des grilles MW. Plus généralement, envoyer des mots vers les jeux
- afficher les lexiques
- extraire une liste d’un lexique (3.4.2)
- faire un partage “safe” d’un lexique à un autre (3.5.2)
- faire un partage “safe” d’une liste à un lexique (4.2.1)
Lancé par
- utilisateur
- système
Request
| Method | URL |
|---|---|
GET |
api/extractFromLex/<n>/<rand> |
| Type | Params | Values | Details |
|---|---|---|---|
URL |
n |
integer |
(optionnal. Default : all) nombre de mots-vedettes à récupérer |
URL |
rand |
bool |
(optionnal. Default : false) Récupérer en ordre aléatoire ou non |
GET |
origin_lex |
Lexicon |
(optionnal. Default : all) Lexique où les n mots-vedettes seront récupérés |
GET |
origin_list |
List |
(optionnal. Default : all) Liste où les n mots-vedettes seront récupérés |
GET |
graphies |
array<string> |
(optionnal. Default : all) Sélection des graphies à récupérer |
GET |
user |
user_id |
identifiant de personne qui fait la requête |
Response
| Status | Response |
|---|---|
| 200 | La réponse sera une array de n graphies. Seront passé en paramètres soit {n, rand, origin_lex, user}, pour récupérer n mots-vedettes d'un lexique, soit {n, rand, origin_list, user}, pour récupérer n mots-vedettes d'une liste, soit {graphies, user}, pour récupérer les graphies sélectionnés. Si n excède le nombre de mots de la cible, en récupérer le plus possible (0 le cas échéant). |
| 401 ou 403 | Utilisateur non authentifié ou requête non autorisée (TODO : définir) |
| 500 | {"error":"Something went wrong. Please try again later."} |
Activity
added API label
marked this issue as related to #42 (closed)
marked this issue as related to #44 (closed)
added Back-end label
@esimonnet A quoi sert le param "graphys" ? Param target_lex default: All, pas vraiment tous les lexiques ? Ceux de la première langue de travail ? Ceux autorissés (par ex. pas les lexiques d'un groupe dont on n'est pas membre, pas le lexique zéro, pas les lexiques "proposition de mot"...)
J'ai modifié la description pour que ça fasse plus sens. Et en le faisant je me demande s'il ne faut pas séparer la requête en plusieurs requêtes différentes
Edited by Enzo Simonnet
added Fermé sans vérif label
