Modernize data representation about helix-data-embed HOT 6 CLOSED

maybe we should change the data format of the returned table, like many others do. just returning the plain JSON array is IMO insufficient.

adding more information about the result set would also help creating pagination etc...

minimal example:

/bla.xls?limit=100&offset=50

{
  total: 5670,
  limit: 100,
  offset: 50,
  data: [ .... ]
}

example with force truncation

/bla.xls?limit=3000

{
  total: 5670,
  limit: 2354,
  offset: 0,
  data: [ .... ]
}

this would also allow for a more efficient format for tables. eg:
/bla.xls?limit=3000&type=matrix

{
  total: 5670,
  limit: 2354,
  offset: 0,
  type: 'matrix',
  columns: [ 'a', 'b', 'c', .... ]
  rows: [[0, 1, 2], [3, 4, 5], ...]
}

from helix-data-embed.

Guess querybuilder should help here too? @trieloff

from helix-data-embed.

Not really. I wouldn’t apply a default truncation, as we don’t have a way of indicating that the result set has been truncated.

One possible solution would be to estimate how many elements would be ok and then send a redirect to the same URL with new QB limits applied. The client can then follow the redirect and accept the truncation.

from helix-data-embed.

@davidnuescheler WDYT about adding the extra data property in the json response ?

from helix-data-embed.

or maybe similar than:

https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination

{
  "skip": 0,
  "limit": 100,
  "total": 1256,
  "items": [ /* 100 individual resources */ ]
}

from helix-data-embed.

🎉 This issue has been resolved in version 2.0.0 🎉

The release is available on:

• v2.0.0
• GitHub release

Your semantic-release bot 📦🚀

from helix-data-embed.