From 376423df64b92e3d35c36b5e7625e6f0acfbd7ec Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Fri, 25 Oct 2024 13:37:35 -0400 Subject: [PATCH 1/2] develop: UF remove language from snippet --- develop-docs/application/feedback-architecture.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/application/feedback-architecture.mdx b/develop-docs/application/feedback-architecture.mdx index b5c064a008c22..fa8281ef159b8 100644 --- a/develop-docs/application/feedback-architecture.mdx +++ b/develop-docs/application/feedback-architecture.mdx @@ -52,7 +52,7 @@ offers 2 improvements: The user's submission is wrapped in a context object: -```Python/Javascript +``` event[”contexts”][”feedback”] = { "name": , "contact_email": , From 794d94662ddbf98a8c9b24ded2ecbf808b99e3ef Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Fri, 25 Oct 2024 13:33:32 -0700 Subject: [PATCH 2/2] Label snippets as pseudo-code and add associated_event_id field to feedback context --- develop-docs/application/feedback-architecture.mdx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/develop-docs/application/feedback-architecture.mdx b/develop-docs/application/feedback-architecture.mdx index fa8281ef159b8..41d25165f38a0 100644 --- a/develop-docs/application/feedback-architecture.mdx +++ b/develop-docs/application/feedback-architecture.mdx @@ -52,17 +52,18 @@ offers 2 improvements: The user's submission is wrapped in a context object: -``` +```Pseudo-code event[”contexts”][”feedback”] = { "name": , "contact_email": , "message": , "url": , - "source": + "source": , + "associated_event_id": } -// all fields are technically optional, but recommended -// the widget can be configured to require a non-empty email and/or name +// All fields are optional except message. +// The widget can be configured to require a non-empty email and/or name. ``` - This doc refers to the payload format (`event` in the pseudo-code above) as a “**feedback event”**. @@ -100,7 +101,7 @@ a separate topic and storage, and the UI makes a separate request for them. The deprecated way of sending feedback is as a **user report**. This is a simple typed dict: -```Python/Javascript +```Pseudo-code user_report = { "event_id": , "email": ,