aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorrr-2016-04-20 21:31:46 +0200
committerrr-2016-04-20 21:31:46 +0200
commit97bd935bb6d64dbb08d331b68341026b8f4c5914 (patch)
tree08ae97f8d4d5a379fa9b7ce7766cd8146c664f83 /API.md
parent747c73068868f6f47de14a9b87e6fa5defc16661 (diff)
server/tags: add listing tag siblings
Diffstat (limited to 'API.md')
-rw-r--r--API.md38
1 files changed, 37 insertions, 1 deletions
diff --git a/API.md b/API.md
index b868d38..609977f 100644
--- a/API.md
+++ b/API.md
@@ -26,6 +26,7 @@
- [Getting tag](#getting-tag)
- [Deleting tag](#deleting-tag)
- [Merging tags](#merging-tags)
+ - [Listing tag siblings](#listing-tag-siblings)
- Users
- [Listing users](#listing-users)
- [Creating user](#creating-user)
@@ -116,7 +117,7 @@ data.
- **Description**
- Lists all tag categories. Doesn't support paging.
+ Lists all tag categories. Doesn't use paging.
**Note**: independently, the server exports current tag category list
snapshots to the data directory under `tags.json` name. Its purpose is to
@@ -552,6 +553,41 @@ data.
exception of the set of posts it's used in.
+## Listing tag siblings
+- **Request**
+
+ `GET /tag-siblings/<name>`
+
+- **Output**
+
+ ```json5
+ {
+ "siblings": [
+ {
+ "tag": <tag>,
+ "occurrences": 2
+ },
+ {
+ "tag": <tag>,
+ "occurrences": 1
+ }
+ ]
+ }
+ ```
+ ...where `<tag>` is a [tag resource](#tag).
+
+- **Errors**
+
+ - privileges are too low
+
+- **Description**
+
+ Lists siblings of given tag, e.g. tags that were used in the same posts as
+ the given tag. `occurrences` field signifies how many times a given sibling
+ appears with given tag. Results are sorted by occurrences count and the
+ list is truncated to the first 50 elements. Doesn't use paging.
+
+
## Listing users
- **Request**

© 2015 - 2026 Jakob L. Kreuze