api.markdown
81 lines
| 1.8 KiB
| text/x-markdown
|
MarkdownLexer
/ docs / api.markdown
|
r503 | # INTRO # | ||
The API is provided to query the data from a neaboard server by any client | ||||
application. | ||||
Tha data is returned in the json format and got by an http query. | ||||
# METHODS # | ||||
|
r524 | ## Threads ## | ||
|
r503 | /api/threads/N/?offset=M&tag=O | ||
|
r524 | Get a thread list. You will get ``N`` threads (required parameter) starting from | ||
``M``th one (optional parameter, default is 0) with the tag ``O`` (optional parameter, | ||||
|
r503 | threads with any tags are shown by default). | ||
|
r524 | ## Tags ## | ||
|
r503 | /api/tags/ | ||
Get all active tag list. Active tag is a tag that has at least 1 active thread | ||||
associated with it. | ||||
|
r524 | ## Thread ## | ||
|
r503 | /api/thread/N/ | ||
|
r524 | Get all ``N``th thread post. ``N`` is an opening post ID for the thread. | ||
|
r525 | Output format: | ||
* ``posts``: list of posts | ||||
* ``last_update``: last update timestamp | ||||
|
r524 | ## Thread diff ## | ||
|
r1087 | /api/diff_thread | ||
Parameters: | ||||
|
r524 | |||
|
r1087 | * ``thread``: thread id | ||
* ``last_update``: last update timestamp | ||||
* ``last_post``: last added post id | ||||
Get the diff of the thread in the `O`` | ||||
|
r524 | format. 2 formats are available: ``html`` (used in AJAX thread update) and | ||
``json``. The default format is ``html``. Return list format: | ||||
* ``added``: list of added posts | ||||
* ``updated``: list of updated posts | ||||
* ``last_update``: last update timestamp | ||||
|
r994 | ## Notifications ## | ||
/api/notifications/<username>/[?last=<id>] | ||||
Get user notifications for user starting from the post ID. | ||||
* ``username``: name of the notified user | ||||
* ``id``: ID of a last notification post | ||||
|
r524 | ## General info ## | ||
|
r503 | |||
In case of incorrect request you can get http error 404. | ||||
|
r523 | |||
|
r525 | Response JSON for a post or thread contains: | ||
|
r523 | |||
|
r524 | * ``id`` | ||
* ``title`` | ||||
* ``text`` | ||||
* ``image`` (if image available) | ||||
* ``image_preview`` (if image available) | ||||
|
r526 | * ``bump_time`` (for threads) | ||
|
r523 | |||
In future, it will also contain: | ||||
* tags list (for thread) | ||||
* publishing time | ||||
* bump time | ||||
* reply IDs (if available) | ||||