simonw/datasette

Gather feedback on new ?_extra= design

Open

#2,042 opened on Mar 22, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (8,637 stars) (625 forks)batch import
help wantedjson-extras

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

Contributor guide

Tech stack
pythonsqlite
Domain
apibackend
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Test the new ? extra= feature using the provided examples (e.g., https://latest.datasette.io/fixtures/sortable.json? extra=columns). Provide feedback on the design, especially the default slim JSON representation and the extra parameter functionality. Comment on the issue with suggestions or observations. No code changes required.
Gather feedback on new ?_extra= design · simonw/datasette#2042 | Good First Issue