diff options
| author | Shyam Sunder <sgsunder1@gmail.com> | 2020-09-19 09:23:26 -0400 |
|---|---|---|
| committer | Shyam Sunder <sgsunder1@gmail.com> | 2020-09-19 10:29:09 -0400 |
| commit | 1ef0419dc28c52d005693f672f27f6bc107cb277 (patch) | |
| tree | c322e87246748c2c1967e462767ba0a0cf4bdfaa /doc | |
| parent | 802051399fc193eda7f06e534d7b3349cc41eb2e (diff) | |
server/pools: serialize pools as micro resource within post resources
Fixes #348
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/API.md | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -99,6 +99,7 @@ - [Micro post](#micro-post) - [Pool category](#pool-category) - [Pool](#pool) + - [Micro pool](#micro-pool) - [Note](#note) - [Comment](#comment) - [Snapshot](#snapshot) @@ -2455,7 +2456,7 @@ One file together with its metadata posted to the site. - `<mime-type>`: subsidiary to `<type>`, used to tell exact content format; useful for `<video>` tags for instance. - `<comment>`: a [comment resource](#comment) for given post. -- `<pool>`: a [pool resource](#pool) for given post. +- `<pool>`: a [micro pool resource](#micro-pool) in which the post is a member of. ## Micro post **Description** @@ -2545,6 +2546,12 @@ An ordered list of posts, with a description and category. - `<description>`: the pool description (instructions how to use, history etc.) The client should render it as Markdown. +## Micro pool +**Description** + +A [pool resource](#pool) stripped down to `id`, `names`, `category`, +`description` and `postCount` fields. + ## Comment **Description** |