Skip to content
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.

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

telemetry: toolkit_showNotification.userChoice #882

Merged
merged 2 commits into from
Oct 11, 2024
Merged
Changes from 1 commit
Commits
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
16 changes: 10 additions & 6 deletions telemetry/definitions/commonDefinitions.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"name": "action",
"type": "string",
"description": "Name of an action that was taken, displayed, etc."
"description": "Name of an action that was taken, displayed, etc. See also `userChoice`."
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's important to connect things with cross-references. That helps discovery, helps avoid duplicate concepts, etc.

},
{
"name": "amazonqCodeGenerationResult",
Expand Down Expand Up @@ -1711,7 +1711,7 @@
{
"name": "userChoice",
"type": "string",
"description": "User selection from a predefined menu (not user-provided input)"
"description": "User selection from a predefined menu (not user-provided input). See also `action`."
},
{
"name": "userId",
Expand Down Expand Up @@ -6794,7 +6794,7 @@
},
{
"name": "toolkit_openModule",
"description": "The user opened 'something' (specified by 'module'). Examples: a view, feature, resource, ...",
"description": "User opened 'something' (specified by 'module'). Examples: a view, feature, resource, ...",
"metadata": [
{
"type": "module",
Expand All @@ -6813,7 +6813,7 @@
},
{
"name": "toolkit_showAction",
"description": "The toolkit tried to show an action. Source represents the notification that produced the action",
"description": "Toolkit presented an action. `source` is the notification that produced the action. See also `toolkit_showNotification`.",
"metadata": [
{
"type": "component",
Expand All @@ -6840,7 +6840,7 @@
},
{
"name": "toolkit_showNotification",
"description": "The toolkit tried to show a notification message",
"description": "Show a notification message, optionally with selected action set in `userChoice`. See also `toolkit_showAction`.",
"metadata": [
{
"type": "component",
Expand All @@ -6850,6 +6850,10 @@
"type": "id",
"required": true
},
{
"type": "userChoice",
"required": false
},
{
"type": "reason",
"required": false
Expand Down Expand Up @@ -6942,4 +6946,4 @@
]
}
]
}
}
Loading