TODO: Add If-Modified-Since/If-None-Match/E-Tag

Boards#

HTTP request Resource URL Description
GET /boards Returns boards list
GET /boards/{board} Returns board info

Variables:

  • {board} (string) — board name

Threads#

HTTP request Resource URL Description
GET /threads Returns thread(s) list
GET /threads/{id} Returns thread and all posts

GET /threads
Parameters:

  • id — list uniquely thread_id IDs (comma separated)
  • board_id — board_id list (comma separated ints)
    • display_id — list thread's display_id (comma separated ints)
  • page (int) — count from 1 (not 0), default = 1
  • per_page (int) — threads per page (from 1 to 100), default = 10
  • op (bool) — if 'True' returns with op-post, default = False

GET /threads/{id}
{id} (int) — thread_id
Parameters:

  • limit (int) — last N posts in this thread, default = all
  • op (bool) — if 'True' returns with op-post

TODO:

  • mine — display only my (token-based authentication)

Posts#

HTTP request Resource URL Description
GET /posts Returns post(s) list
GET /posts/{id} Returns post
GET, PUT /posts/{id}/error Errors handling
POST /posts Creates new thread
PUT /posts Updates or modifies post
DELETE /posts Deletes a post (only one per request?)

GET /posts
Parameters:

  • id — list uniquely post_id IDs (comma separated)
  • thread_id — thread_id list (comma separated ints)
  • board_id — board_id list (comma separated ints)
    • display_id — list posts's display_id (comma separated ints)
  • page (int) — count from 1 (not 0), default = 1
  • per_page (int) — posts per page (from 1 to 100), default = 10

GET /posts/{id}
{id} (int) — post_id

Edit
Pub: Sep 24 2018 19:27 UTC
Views: 279