diff --git a/src/content/docs/components/iota/endpoints.md b/src/content/docs/components/iota/endpoints.md index 1c73a53..2dd4c26 100644 --- a/src/content/docs/components/iota/endpoints.md +++ b/src/content/docs/components/iota/endpoints.md @@ -453,23 +453,21 @@ The iota will never read, or handle the chat_partner_name. ## User Settings +Settings are scoped to the authenticated device session. The `SessionId` must match the session assigned by the Omikron. Setting names may contain alphanumeric characters, `_`, `-`, and `.`, but may not contain `..`. + ### Save user Settings on Iota ##### `REQ:` ```json { - "type": "settings_save", + "type": "SettingsSave", "id": "", "data": { - "setting_name": "", - "payload": { - "this": "will", - "be": "saved", - "on": "the", - "iota": "!" - } + "SessionId": 12345, + "SettingsName": "", + "Payload": "" } } ``` @@ -478,11 +476,14 @@ The iota will never read, or handle the chat_partner_name. ```json { - "type": "settings_save", + "type": "SettingsSave", "id": "", "receiver": "", - "data": {} + "data": { + "SessionId": 12345, + "SettingsName": "" + } } ``` @@ -492,11 +493,12 @@ The iota will never read, or handle the chat_partner_name. ```json { - "type": "settings_load", + "type": "SettingsLoad", "id": "", "data": { - "setting_name": "" + "SessionId": 12345, + "SettingsName": "" } } ``` @@ -505,18 +507,16 @@ The iota will never read, or handle the chat_partner_name. ```json { - "type": "settings_load", + "type": "SettingsLoad", "id": "", "receiver": "", "data": { - "setting_name": "", - "payload": { - "this": "will", - "be": "saved", - "on": "the", - "iota": "!" - } + "SessionId": 12345, + "SettingsName": "", + "Payload": "" } } ``` + +Loading a setting that does not exist returns `ErrorNotFound` with the requested `SessionId` and `SettingsName`.