Skip to content

Commit 852f8ab

Browse files
bruno-garciaaliu39
andauthored
develop: UF remove language from snippet (#11662)
* develop: UF remove language from snippet * Label snippets as pseudo-code and add associated_event_id field to feedback context --------- Co-authored-by: Andrew Liu <[email protected]>
1 parent b9abfd5 commit 852f8ab

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

develop-docs/application/feedback-architecture.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,18 @@ offers 2 improvements:
5252

5353
The user's submission is wrapped in a context object:
5454

55-
```Python/Javascript
55+
```Pseudo-code
5656
event[”contexts”][”feedback”] = {
5757
"name": <user-provided>,
5858
"contact_email": <user-provided>,
5959
"message": <user-provided>,
6060
"url": <referring web page>,
61-
"source": <developer-provided, ex: "widget">
61+
"source": <developer-provided, ex: "widget">,
62+
"associated_event_id": <developer-provided, should be a valid error event in the same project>
6263
}
6364
64-
// all fields are technically optional, but recommended
65-
// the widget can be configured to require a non-empty email and/or name
65+
// All fields are optional except message.
66+
// The widget can be configured to require a non-empty email and/or name.
6667
```
6768

6869
- 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.
100101

101102
The deprecated way of sending feedback is as a **user report**. This is a simple typed dict:
102103

103-
```Python/Javascript
104+
```Pseudo-code
104105
user_report = {
105106
"event_id": <required UUID str>,
106107
"email": <optional str>,

0 commit comments

Comments
 (0)