Skip to content

Commit

Permalink
update list of keys in ui notification (#153)
Browse files Browse the repository at this point in the history
  • Loading branch information
BryonLewis authored Jun 19, 2024
1 parent f20a2a3 commit 0e446fc
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/UI-Notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ There is a REST endpoint: `POST /dive_rpc/ui_notificaitions/{id}` that takes in

## JSON Body Data
The JSON format is relatively simple but may be updated in the future to have additional fields and provide further actions.

* *text* (string) - This is a required string that is displayed to the user. It provides some context to the user about what is being selected or why data is being changed
* *reloadAnnotations* (boolean) <Optional> - If this is true it is the only action that will be performed. Instead of performing any other actions it will reload the page.
* *selectedTrack* (number) <Optional> - integer number to select a specific track
Expand Down

0 comments on commit 0e446fc

Please sign in to comment.