simonw/datasette

Gather feedback on new ?_extra= design

Fermée

#2 042 ouverte le 22 mars 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (625 forks)batch import
help wantedjson-extras

Métriques du dépôt

Stars
 (8 637 étoiles)
Métriques de merge PR
 (Merge moyen 67j 23h) (19 PRs mergées en 30 j)

Description

Now that I've landed:

  • #1999

See also:

  • #262

I want to get some feedback from people on the design of the new ?_extra= feature, before freezing it into Datasette 1.0.

The big change is that the default JSON representation is now MUCH slimmer - it only gives you keys for "next" and "rows", where rows is a list of JSON objects (not a list of arrays as was previously the default) - for example https://latest.datasette.io/fixtures/sortable.json

If you want extra stuff you can ask for it with the new ?_extra= parameter - e.g. https://latest.datasette.io/fixtures/sortable.json?_extra=columns&_extra=suggested_facets

You can use ?_extra=extras to see a list of available extras: https://latest.datasette.io/fixtures/sortable.json?_extra=extras

Guide contributeur

Direction de recherche
Testez la nouvelle fonctionnalité ? extra= en utilisant les exemples fournis (par exemple, https://latest.datasette.io/fixtures/sortable.json? extra=columns). Fournissez des retours sur la conception, en particulier la représentation JSON slim par défaut et la fonctionnalité du paramètre extra. Commentez l'issue avec des suggestions ou des observations. Aucune modification de code n'est requise.
Stack technique
pythonsqlite
Domaine
apibackend
Type d'issue
Recherche
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80