From bb699d4a4ab6115c5c650ea88e6c94aa60288e9d Mon Sep 17 00:00:00 2001 From: Matt Johnson-Pint Date: Mon, 28 Mar 2022 09:46:07 -0700 Subject: [PATCH 1/2] Add client report item type to envelopes spec --- src/docs/sdk/envelopes.mdx | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/docs/sdk/envelopes.mdx b/src/docs/sdk/envelopes.mdx index 18daf435c2..1b3d9b3f62 100644 --- a/src/docs/sdk/envelopes.mdx +++ b/src/docs/sdk/envelopes.mdx @@ -465,6 +465,26 @@ The item contains a user feedback / user report JSON payload: *None* +### Client Report + +Item type `"client_report"` contains a client report payload encoded in JSON. + +See the client reports documentation for the payload +details. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item can either be included in an Envelope with other Items, or it may be sent by itself. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + ### Reserved Types Reserved types may not be written by any implementation. They are reserved for From 1bf2f9089ba2ebb0a17c9fdece8496e8a0a2bd18 Mon Sep 17 00:00:00 2001 From: Matt Johnson-Pint Date: Wed, 30 Mar 2022 07:53:21 -0700 Subject: [PATCH 2/2] Update envelopes.mdx --- src/docs/sdk/envelopes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/envelopes.mdx b/src/docs/sdk/envelopes.mdx index 1b3d9b3f62..2ea1cac386 100644 --- a/src/docs/sdk/envelopes.mdx +++ b/src/docs/sdk/envelopes.mdx @@ -474,7 +474,7 @@ details. **Constraints:** -- This Item may occur at most once per Envelope. +- This Item may occur multiple times per Envelope, but please avoid sending more client reports than necessary. - This Item can either be included in an Envelope with other Items, or it may be sent by itself. **Envelope Headers:**