Projet

Général

Profil

Bug #52094

greco, ajouter des descriptions aux endpoints

Ajouté par Frédéric Péters il y a environ 3 ans. Mis à jour il y a environ 3 ans.

Statut:
Fermé
Priorité:
Normal
Assigné à:
Version cible:
-
Début:
16 mars 2021
Echéance:
% réalisé:

0%

Temps estimé:
Patch proposed:
Oui
Planning:
Non

Description

Sûr on peut deviner ce qu'un endpoint est supposé faire via son nom mais avoir deux/trois mots de description serait quand même sympa.


Fichiers


Demandes liées

Lié à Passerelle - Development #53057: appliquer |linebreaks à long_descriptionFermé13 avril 2021

Actions

Révisions associées

Révision 3231dd35 (diff)
Ajouté par Nicolas Roche il y a environ 3 ans

greco: add description to endpoints (#52094)

Historique

#1

Mis à jour par Nicolas Roche il y a environ 3 ans

Oui, d'autant plus qu'il manquait le détails du dernier endpoint ajouté.

(il y avait quelques incohérences dans les paramètres et donc j'ai convergé vers ce qui est fait dans endpoint.html)

#2

Mis à jour par Frédéric Péters il y a environ 3 ans

Juste un coup d'œil sur la capture : il est écrit "arf" sous l'endpoint add-information.

Ça révèle quand même que "update" est un mauvais nom pour l'endpoint, vu qu'il ne s'agit pas d'une mise à jour de la demande; mais c'est a priori trop tard pour changer ça.

La description pour "add-confirmation" me semble bien bizarre et j'ai du mal à suivre des tickets parfois pas liés pour trouver l'explicaiton à ce décalage.

#3

Mis à jour par Nicolas Roche il y a environ 3 ans

arf

arf

"update" est un mauvais nom pour l'endpoint... ; mais c'est a priori trop tard pour changer ça.

il est là depuis longtemps mais je pense qu'il n'est pas encore utilisé (je peux encore le modifier asap, ainsi que add-information et add-confirmation)
cf : https://demarches.toodego.com/backoffice/workflows/35/ et https://demarches.guichet-recette.grandlyon.com/backoffice/workflows/44/

La description pour "add-confirmation" me semble bien bizarre

Merci, je réalise que j'ai pris un libellé obsolète.
C'est issu des specs données ici : https://dev.entrouvert.org/issues/49927

1.5 Mise en œuvre du +1.
Scénario usage : Un utilisateur fait un + 1 sur Toodego. Ce dernier, n’est actuellement pas pris en compte.
+1 actuel : A ce jour, réaliser un +1 sur Toodego, c’est s’abonner à une liste de diffusion permettant de suivre l’avancement de la démarche
Evolution envisagée : Dès qu’un +1 est fait, il faut incrémenter un compteur qui est transmis à GRECO par webservice

edit:
J'ai mis : 'Update number of confirmations (+1) related to a demand'

#5

Mis à jour par Nicolas Roche il y a environ 3 ans

  • Tracker changé de Development à Bug

(je passe en bug parce qu'actuellement il manque la description du dernier endpoint ajouté #51812)

#6

Mis à jour par Frédéric Péters il y a environ 3 ans

Pourquoi ça passe par l'html et pas par l'ajout des infos dans les @endpoint et la génération automatique de la page ? (il manquerait quoi pour y arriver ?).

#7

Mis à jour par Nicolas Roche il y a environ 3 ans

Je pense que c'est lié à la gestion des fichiers attachés qui sont gérés à la main dans la méthode send et qui occasionnent une gestion particulière du schéma JSON dans formdata.py. Ça donne un template exotique :

<div class="body-schemas"><samp>
{ {% for field in object.creation_fields %}"{{ field }}":&nbsp;"…", {% endfor %}
"fichier1":&nbsp;{"filename":&nbsp;"….…", "content_type":&nbsp;"…/…", "content":&nbsp;"…base64…" },
"fichier2":&nbsp;{ … }
}
</samp>
</div>

J'avoue ne pas avoir recherché dans les autres connecteurs SOAP comment sont gérées les pièces jointes,
mais j'ai peur qu'il s'agisse ici de ré-écrire le connecteur.

#8

Mis à jour par Frédéric Péters il y a environ 3 ans

Ton propos c'est "il y a un gabarit particulier pour afficher les infos des endpoints parce que quelque chose de particulier sur l'endpoint create", c'est bien ça ?

Si c'est ça, je serais pour #53057, que l'info soit rapatriée dans l'endpoint, basiquement des bouts de ce type :

-    @endpoint(perm='can_access', methods=['post'])
+    @endpoint(perm='can_access', methods=['post'], long_description='''Payload JSON:
+{ "iddemande": "…", "description": "…", "domaineobjettype": "…", "datecreation": "…", "datedepot": "…", "danger": "…", "mediareponse": "…", "priorite": "…", "application": "…", "beneficiaire_civilite": "…", "beneficiaire_nom": "…", "beneficiaire_prenom": "…", "beneficiaire_email": "…", "beneficiaire_mobile": "…", "beneficiaire_telephone": "…", "beneficiaire_fax": "…", "beneficiaire_numerovoie": "…", "beneficiaire_voie": "…", "beneficiaire_codefuvvoie": "…", "beneficiaire_coderivolivoie": "…", "beneficiaire_complement": "…", "beneficiaire_codepostal": "…", "beneficiaire_commune": "…", "beneficiaire_organisation": "…", "beneficiaire_typetiers": "…", "localisation_numerovoie": "…", "localisation_voie": "…", "localisation_codefuvvoie": "…", "localisation_coderivolivoie": "…", "localisation_complement": "…", "localisation_commune": "…", "localisation_voiesecante": "…", "localisation_codefuvvoiesecante": "…", "localisation_coderivolivoiesecante": "…", "localisation_xgeoloc": "…", "localisation_ygeoloc": "…", "transmetteur_civilite": "…", "transmetteur_nom": "…", "transmetteur_prenom": "…", "transmetteur_email": "…", "transmetteur_mobile": "…", "transmetteur_telephone": "…", "transmetteur_fax": "…", "transmetteur_service": "…", "fichier1": {"filename": "….…", "content_type": "…/…", "content": "…base64…" }, "fichier2": { … } }
+
+Réponse :
+{"data": {"application": "…", "etat": "1 - Créée", "iddemande": "…", "idgreco": "…", "motifsrejet": null}, "err": 0}''')

Et que le bloc "endpoints" de passerelle/contrib/greco/templates/greco/greco_detail.html soit dégagé.

#9

Mis à jour par Frédéric Péters il y a environ 3 ans

#11

Mis à jour par Frédéric Péters il y a environ 3 ans

  • Statut changé de Solution proposée à Solution validée

Il y a un bout "Response" des bouts "Réponse", ça m'irait que ça soit uniformément non-traduit et qu'il soit plus tard réfléchi à la manière de permettre ces traductions sans avoir à porter dans le .po le contenu exemple.

Aussi, même sans effet sur le rendu, le json des long_description pourrait être indenté pour gagner en lisibilité.

Et pour le PUT pourri au milieu, je viens de créer #53480.

#12

Mis à jour par Nicolas Roche il y a environ 3 ans

  • Statut changé de Solution validée à Résolu (à déployer)

(remarques prises en compte)

commit 3231dd358fcac2a6db87b9416e748fab4eef3ea3
Author: Nicolas ROCHE <nroche@entrouvert.com>
Date:   Wed Mar 17 16:25:49 2021 +0100

    greco: add description to endpoints (#52094)
#13

Mis à jour par Frédéric Péters il y a environ 3 ans

  • Statut changé de Résolu (à déployer) à Solution déployée

Formats disponibles : Atom PDF