simonw/datasette

Gather feedback on new ?_extra= design

Geschlossen

#2.042 geöffnet am 22.03.2023

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (625 Forks)batch import
help wantedjson-extras

Repository-Metriken

Stars
 (8.637 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 67T 23h) (19 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Testen Sie die neue ? extra= Funktion anhand der bereitgestellten Beispiele (z.B. https://latest.datasette.io/fixtures/sortable.json? extra=columns). Geben Sie Feedback zum Design, insbesondere zur standardmäßigen schlanken JSON Darstellung und zur Funktionalität des extra Parameters. Kommentieren Sie das Issue mit Vorschlägen oder Beobachtungen. Keine Codeänderungen erforderlich.
Tech Stack
pythonsqlite
Domain
apibackend
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80