Project

General

Profile

Development #25491

DPark: Intégrer la documentation au connecteur

Added by Josué Kouka almost 2 years ago. Updated over 1 year ago.

Status:
En cours
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
26 Jul 2018
Due date:
% Done:

100%

Patch proposed:
No
Planning:
No

Description

La doc doit etre dans la vue décrivant les différents endpoints du connecteur.

0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch View (37.4 KB) Josué Kouka, 06 Aug 2018 04:28 PM

0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch View (37.4 KB) Josué Kouka, 06 Aug 2018 05:12 PM


Related issues

Related to Passerelle - Development #25432: Étendre les possibilités de documentation des connecteurs Nouveau 23 Jul 2018

History

#1 Updated by Josué Kouka almost 2 years ago

#2 Updated by Paul Marillonnet almost 2 years ago

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.

#3 Updated by Josué Kouka almost 2 years ago

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

#4 Updated by Frédéric Péters almost 2 years ago

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.

#5 Updated by Frédéric Péters almost 2 years ago

  • Status changed from Solution proposée to En cours
  • Patch proposed changed from Yes to No

Très clairement Josué n'aura pas le temps cet été pour faire les choses correctement, je propose de laisser ça de côté.

#6 Updated by Josué Kouka almost 2 years ago

  • Tracker changed from Support to Development

#7 Updated by Josué Kouka almost 2 years ago

  • Related to Development #25432: Étendre les possibilités de documentation des connecteurs added

#8 Updated by Josué Kouka almost 2 years ago

  • % Done changed from 0 to 100

#9 Updated by Frédéric Péters over 1 year ago

  • Assignee deleted (Josué Kouka)

Also available in: Atom PDF