Documentation/AccountHub
2
1
Fork 0
Code Issues 2 Pull Requests Releases Activity

Fix typo

Browse Source
This commit is contained in:
Skylar Ittner 2019-01-03 00:38:29 -07:00
parent dae183e17c
commit 02fdca4b60
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Self-Hosting and Development/API Documentation.md
View File

@ -1,6 +1,6 @@
# API Documentation # API Documentation
The NotePost API is extremely simple to use. Requests can be sent via GET or POST, and responses are sent in JSON. The AccountHub API is extremely simple to use. Requests can be sent via GET or POST, and responses are sent in JSON.
## Request Structure ## Request Structure
@ -46,4 +46,4 @@ If the request is not well-formed (missing required arguments, invalid credentia
| `getnotifications` | `username` or `uid` | Get notifications for the user. When successful, returns an array `notifications` with items similar to: `{"id": 1, "timestamp": "YYYY-MM-DD HH:MM:SS", "title": "text", "content": "text", "url": "text", "seen": false, "sensitive": false}` | `getnotifications` | `username` or `uid` | Get notifications for the user. When successful, returns an array `notifications` with items similar to: `{"id": 1, "timestamp": "YYYY-MM-DD HH:MM:SS", "title": "text", "content": "text", "url": "text", "seen": false, "sensitive": false}`
| `readnotification` | `username` or `uid`, `id` | Mark the notification identified by the user and notification ID as read. Sets `seen` to `true` in future calls to `getnotifications`, and changes how the notification is displayed in the UI. | `readnotification` | `username` or `uid`, `id` | Mark the notification identified by the user and notification ID as read. Sets `seen` to `true` in future calls to `getnotifications`, and changes how the notification is displayed in the UI.
| `addnotification` | `username` or `uid`, `title`, `content`, `timestamp` (optional, defaults to current date/time), `url` (optional, defaults to empty string), `sensitive` (optional, defaults to `false`) | Add a notification for the given user with the content. | `addnotification` | `username` or `uid`, `title`, `content`, `timestamp` (optional, defaults to current date/time), `url` (optional, defaults to empty string), `sensitive` (optional, defaults to `false`) | Add a notification for the given user with the content.
| `deletenotification` | `username` or `uid`, `id` | Delete the notification identified by the user and notifiation ID. | `deletenotification` | `username` or `uid`, `id` | Delete the notification identified by the user and notifiation ID.