search

etalab / transport-site

Rendre disponible, valoriser et améliorer les données transports
https://transport.data.gouv.fr
194 stars 30 forks source link

Champs à ne pas exposer dans l'API ? #2183

Open fchabouis opened 2 years ago

fchabouis commented 2 years ago

Je remarque qu'on a des champs dans l'api qui ne sont probablement pas pertinents pour l'exterieur. Je vois des from_old_system, old_href, old_payload

par exemple : https://transport.data.gouv.fr/api/datasets/6036e9df9d7c9b462c7ce5a4

Il faudrait trier ce qui est pertinent ou pas pour nos utilisateurs.

AntoineAugusti commented 2 years ago

Ce sont certaines clés d'un champ JSON, c'est facile à faire ?

thbar commented 2 years ago

Il faudrait trier ce qui est pertinent ou pas pour nos utilisateurs.

Il serait bon d'avoir une approche "whitelist" (= on n'affiche que ce qui est explicitement déclaré) plutôt que "blacklist" (= on enlève des champs spécifiques), car sinon notre API va changer sans qu'on s'en rende compte, ce qui complique la vie d'un réutilisateur (sans parler d'avoir un versioning bien ficelé).

fchabouis commented 2 years ago

j'ai pas bien regardé d'où venaient ces champs, du coup je ne sais s'il est facile ou non de les trier. Et je n'ai pas beaucoup touché au code de l'API. J'ai juste créé l'issue en me rendant compte du problème pour ne pas oublier :)

AntoineAugusti commented 2 years ago

@thbar Si tu veux remplacer l'utilisation de "whitelist" (et équivalents) par "allowlist", je recommande chaudement https://cds-snc.github.io/talent/inclusive-lexicon/