tensamin/docs
Watch
6
0
Fork
You've already forked docs
 0
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions

Update settings endpoints
All checks were successful
/ deploy (push) Successful in 59s
Details

Browse source
This commit is contained in:
Alois 2026-07-29 12:51:11 +02:00
commit 1420f28026
Signed by: alois
SSH key fingerprint: SHA256:GBzT2DXvAuGV9XIV5W3WrzVpjU54FThmxHXdbz95J24
1 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/content/docs/components/iota/endpoints.md
View file

@ -453,23 +453,21 @@ The iota will never read, or handle the chat_partner_name.
## User Settings ## 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 ### Save user Settings on Iota
##### `REQ:` ##### `REQ:`
```json ```json
{ {
"type": "settings_save", "type": "SettingsSave",
"id": "<message_id>", "id": "<message_id>",
"data": { "data": {
"setting_name": "<name of category>", "SessionId": 12345,
"payload": { "SettingsName": "<name of category>",
"this": "will", "Payload": "<serialized or encrypted settings>"
"be": "saved",
"on": "the",
"iota": "!"
}
} }
} }
``` ```
@ -478,11 +476,14 @@ The iota will never read, or handle the chat_partner_name.
```json ```json
{ {
"type": "settings_save", "type": "SettingsSave",
"id": "<message_id>", "id": "<message_id>",
"receiver": "<user_id>", "receiver": "<user_id>",
"data": {} "data": {
"SessionId": 12345,
"SettingsName": "<name of category>"
}
} }
``` ```
@ -492,11 +493,12 @@ The iota will never read, or handle the chat_partner_name.
```json ```json
{ {
"type": "settings_load", "type": "SettingsLoad",
"id": "<message_id>", "id": "<message_id>",
"data": { "data": {
"setting_name": "<name of category>" "SessionId": 12345,
"SettingsName": "<name of category>"
} }
} }
``` ```
@ -505,18 +507,16 @@ The iota will never read, or handle the chat_partner_name.
```json ```json
{ {
"type": "settings_load", "type": "SettingsLoad",
"id": "<message_id>", "id": "<message_id>",
"receiver": "<user_id>", "receiver": "<user_id>",
"data": { "data": {
"setting_name": "<name of category>", "SessionId": 12345,
"payload": { "SettingsName": "<name of category>",
"this": "will", "Payload": "<serialized or encrypted settings>"
"be": "saved",
"on": "the",
"iota": "!"
}
} }
} }
``` ```
Loading a setting that does not exist returns `ErrorNotFound` with the requested `SessionId` and `SettingsName`.