github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

New ?_shape=array option + tweaks to _shape, closes #245

Browse source 
* Default is now ?_shape=arrays (renamed from lists)
* New ?_shape=array returns an array of objects as the root object
* Changed ?_shape=object to return the object as the root
* Updated docs
This commit is contained in:
Simon Willison 2018-05-01 17:08:16 -07:00 • committed by Simon Willison
commit a4cc5dc813
3 changed files with 74 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/json_api.rst
View file

@ -59,13 +59,35 @@ The ``_shape`` parameter can be used to access alternative formats for the
``rows`` key which may be more convenient for your application. There are three
options:
* ``?_shape=lists`` - the default option, shown above
* ``?_shape=objects`` - a list of JSON key/value objects
* ``?_shape=object`` - a JSON object keyed using the primary keys of the rows
* ``?_shape=arrays`` - ``"rows"`` is the default option, shown above
* ``?_shape=objects`` - ``"rows"`` is a list of JSON key/value objects
* ``?_shape=array`` - the entire response is an array of objects
* ``?_shape=object`` - the entire response is a JSON object keyed using the primary keys of the rows
``objects`` looks like this::
"rows": [
{
"database": "sf-trees",
...
"rows": [
{
"id": 1,
"value": "Myoporum laetum :: Myoporum"
},
{
"id": 2,
"value": "Metrosideros excelsa :: New Zealand Xmas Tree"
},
{
"id": 3,
"value": "Pinus radiata :: Monterey Pine"
}
]
}
``array`` looks like this::
[
{
"id": 1,
"value": "Myoporum laetum :: Myoporum"
@ -82,7 +104,7 @@ options:
``object`` looks like this::
"rows": {
{
"1": {
"id": 1,
"value": "Myoporum laetum :: Myoporum"