Development #25491
DPark: Intégrer la documentation au connecteur
100%
Description
La doc doit etre dans la vue décrivant les différents endpoints du connecteur.
Fichiers
Demandes liées
Historique
Mis à jour par Josué Kouka il y a plus de 5 ans
- Fichier 0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch 0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch ajouté
- Statut changé de Nouveau à Solution proposée
- Patch proposed changé de Non à Oui
Mis à jour par Paul Marillonnet il y a plus de 5 ans
Sur la forme :
- cardnumber est décrit par "Numéro de badge" alors qu'il y a déjà un badgenumber.
- lastname au singulier est décrit par "Noms" au pluriel.
- batiment -> bâtiment
- residence -> résidence
- Numero -> Numéro
- Boite -> Boîte
- Modele -> Modèle
- Ville ou se situe[...] -> Ville où se situe [...]
- medecins -> médecins
- (signature du pro et du commerçant -> manque la parenthèse
- le meme -> le même
Et je ne comprends pas le principe de description trivaluée {"O","N",""} des colonnes Required Values et Required.
Mis à jour par Josué Kouka il y a plus de 5 ans
- Fichier 0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch 0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch ajouté
Paul Marillonnet a écrit :
Sur la forme :
- cardnumber est décrit par "Numéro de badge" alors qu'il y a déjà un badgenumber.
- lastname au singulier est décrit par "Noms" au pluriel.
- batiment -> bâtiment
- residence -> résidence
- Numero -> Numéro
- Boite -> Boîte
- Modele -> Modèle
- Ville ou se situe[...] -> Ville où se situe [...]
- medecins -> médecins
- (signature du pro et du commerçant -> manque la parenthèse
- le meme -> le même
Et je ne comprends pas le principe de description trivaluée {"O","N",""} des colonnes Required Values et Required.
Merci pour tes retours. Un patch qui les prend en compte
Mis à jour par Frédéric Péters il y a plus de 5 ans
La doc doit apparaitre sur la page mais pour moi ce n'est pas comme ça qu'elle doit y arriver, elle se trouve presque autant déconnectée du code que dans une page du wiki. Il faut que la documentation arrive en passant le nécessaire dans @endpoint.
- @endpoint(name='check-renewal-time', perm='can_access', description=_('Check if renewal time has not expired'))
+ @endpoint(name='check-renewal-time',
+ perm='can_access',
+ description=_('Check if renewal time has not expired'),
+ parameters={
+ 'firstnames': {
+ 'description': _('Subscriber first names'),
+ ...
+ )
Mais j'avais déjà créé #25432 sur le sujet.
Mis à jour par Frédéric Péters il y a plus de 5 ans
- Statut changé de Solution proposée à En cours
- Patch proposed changé de Oui à Non
Très clairement Josué n'aura pas le temps cet été pour faire les choses correctement, je propose de laisser ça de côté.
Mis à jour par Josué Kouka il y a plus de 5 ans
- Lié à Development #25432: Étendre les possibilités de documentation des connecteurs ajouté