Merge pull request moby#51668 from ndeloof/jsonl

use mime-type application/jsonl to align with openapi 3.2

Author: thaJeztah

api/docs/CHANGELOG.md

@@ -17,6 +17,8 @@ keywords: "API, Docker, rcli, REST, documentation"
 
 * `GET /info` now includes an `NRI` field. If the Node Resource Interface (NRI)
   is enabled, this field contains information describing it.
+* `GET /events` now also supports [`application/jsonl`](https://jsonlines.org/)
+  when negotiating content-type.
 * Deprecated: The `POST /grpc` and `POST /session` endpoints are deprecated and
   will be removed in a future version.
 

api/swagger.yaml

@@ -10463,6 +10463,7 @@ paths:
 
       operationId: "SystemEvents"
       produces:
+        - "application/jsonl"
         - "application/x-ndjson"
         - "application/json-seq"
       responses:

api/types/types.go

@@ -10,9 +10,12 @@ const (
 	// MediaTypeJSON is the MIME-Type for JSON objects.
 	MediaTypeJSON = "application/json"
 
-	// MediaTypeNDJSON is the MIME-Type for Newline Delimited JSON objects streams.
+	// MediaTypeNDJSON is the MIME-Type for Newline Delimited JSON objects streams (https://github.com/ndjson/ndjson-spec).
 	MediaTypeNDJSON = "application/x-ndjson"
 
+	// MediaTypeJSONLines is the MIME-Type for JSONLines objects streams (https://jsonlines.org/).
+	MediaTypeJSONLines = "application/jsonl"
+
 	// MediaTypeJSONSequence is the MIME-Type for JSON Text Sequences (RFC7464).
 	MediaTypeJSONSequence = "application/json-seq"
 )

client/internal/json-stream.go

@@ -17,7 +17,7 @@ func NewJSONStreamDecoder(r io.Reader, contentType string) DecoderFn {
 	switch contentType {
 	case types.MediaTypeJSONSequence:
 		return json.NewDecoder(NewRSFilterReader(r)).Decode
-	case types.MediaTypeJSON, types.MediaTypeNDJSON:
+	case types.MediaTypeJSON, types.MediaTypeNDJSON, types.MediaTypeJSONLines:
 		fallthrough
 	default:
 		return json.NewDecoder(r).Decode

client/system_events.go

@@ -46,6 +46,7 @@ func (cli *Client) Events(ctx context.Context, options EventsListOptions) Events
 
 		headers := http.Header{}
 		headers.Add("Accept", types.MediaTypeJSONSequence)
+		headers.Add("Accept", types.MediaTypeJSONLines)
 		headers.Add("Accept", types.MediaTypeNDJSON)
 		resp, err := cli.get(ctx, "/events", query, headers)
 		if err != nil {

daemon/server/httputils/json-seq.go

@@ -21,7 +21,7 @@ func NewJSONStreamEncoder(w io.Writer, contentType string) EncoderFn {
 			json: jsonEncoder,
 		}
 		return jseq.Encode
-	case types.MediaTypeNDJSON, types.MediaTypeJSON:
+	case types.MediaTypeNDJSON, types.MediaTypeJSON, types.MediaTypeJSONLines:
 		fallthrough
 	default:
 		return jsonEncoder.Encode

daemon/server/router/system/system_routes.go

@@ -311,6 +311,7 @@ func (s *systemRouter) getEvents(ctx context.Context, w http.ResponseWriter, r *
 	}
 
 	contentType := httputil.NegotiateContentType(r, []string{
+		types.MediaTypeJSONLines,
 		types.MediaTypeNDJSON,
 		types.MediaTypeJSONSequence,
 	}, types.MediaTypeJSON) // output isn't actually JSON but API used to  this content-type