Skip to content

Faire de la pédagogie sur l'API tabulaire #2002

@johanricher

Description

@johanricher

Titre inspiré de #1994 et il y a sûrement des synergies entre les 2 tickets.

Actuellement une API appelée "tabulaire" (documentation) est disponible pour chaque fichier publié sur data.gouv.fr, ayant un format et volume compatible, depuis un onglet nommé "Swagger".

Exemples de problèmes

  • le nom de l'API ("tabulaire") est peu clair
  • l'API est relativement peu découvrable au niveau de chaque fichier (onglet "Swagger")
  • quand l'API n'est pas disponible pour un fichier, la raison n'est pas intuitive

Propositions

Quelques idées à ce stade

  • ajouter un lien vers la doc dans l'onglet "Swagger"
  • renommer l'onglet "Swagger" en "API" et le faire apparaitre y compris quand le fichier n'est pas compatible (trop gros par exemple) pour qu'on puisse comprendre pourquoi (renvoi vers la doc)
  • ajouter des liens d'ancrage pour les onglets afin de pouvoir pointer vers l'API d'un fichier (peut-être compliqué vu la quantité d'onglets sur la page d'un jeu de données datagouv et les imbrications entre jeu de données / fichier)
  • renommer "API tabulaire data.gouv.fr" en "API fichiers data.gouv.fr" (découvrable pour chaque fichier sur datagouv et limitée pour l'instant à certains types et tailles de fichiers)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions