Skip to content

develop: UF remove language from snippet #11662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 25, 2024
+6 −5
Merged

develop: UF remove language from snippet #11662

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
376423d
develop: UF remove language from snippet
bruno-garcia Oct 25, 2024
794d946
Label snippets as pseudo-code and add associated_event_id field to fe…
aliu39 Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions develop-docs/application/feedback-architecture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,18 @@ offers 2 improvements:

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

```Python/Javascript
```Pseudo-code
event[”contexts”][”feedback”] = {
"name": <user-provided>,
"contact_email": <user-provided>,
"message": <user-provided>,
"url": <referring web page>,
"source": <developer-provided, ex: "widget">
"source": <developer-provided, ex: "widget">,
"associated_event_id": <developer-provided, should be a valid error event in the same project>
}

// 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”**.
Expand Down Expand Up @@ -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": <required UUID str>,
"email": <optional str>,
Expand Down
Loading