ruby-grape / grape / 39247250281

100%

push

github

Add a built-in :jsonl (JSON Lines) format (#3029)

`format :jsonl` serves JSON Lines: an Array renders one line per element
and any other object one line, each as the JSON formatter renders it; a
String is served as it is. An Enumerator body is streamed, each element
rendered only as the server reads the body, so a large export never sits
in memory whole. A formatter now signals that by handing back a
Grape::ServeStream::StreamResponse, which the formatter middleware serves
the way it serves `stream`.

A JSON Lines request body parses into an Array of its lines' values,
skipping blank lines, and stays in env['api.request.body'] like a JSON
Array body. Errors render as one JSON line.

:jsonl is kept out of ContentTypes::DEFAULTS, which every API that
declares no content type negotiates. An API declares it like any other
format, `content_type :jsonl, 'application/jsonl'` (or
application/x-ndjson), before `format :jsonl`.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

1511 of 1513 branches covered (99.87%)

Branch coverage included in aggregate %.

30 of 30 new or added lines in 4 files covered. (100.0%)

4519 of 4520 relevant lines covered (99.98%)

29978.45 hits per line