From 8bf06597d40143e097ad57011646c1865494ceea Mon Sep 17 00:00:00 2001 From: "R.I.Pienaar" Date: Fri, 1 May 2020 11:24:30 +0200 Subject: [PATCH] clarify error schemas can be mostly empty --- doc/adr/0001-jetstream-json-api-design.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/adr/0001-jetstream-json-api-design.md b/doc/adr/0001-jetstream-json-api-design.md index 8d56b5f7..ef136175 100644 --- a/doc/adr/0001-jetstream-json-api-design.md +++ b/doc/adr/0001-jetstream-json-api-design.md @@ -33,7 +33,8 @@ All Admin APIs that today accept `nil` body should also accept an empty JSON doc All responses will be JSON objects, a few examples will describe it best. Any error that happens has to be communicated within the originally expected message type. Even the case where JetStream is not enabled for -an account, the response has to be the data type the API would normally generate with additional `error`. +an account, the response has to be a valid data type with the addition of `error`. When `error` is present +empty fields may be omitted as long as the response still adheres to the schema. Successful Stream Info: