aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorrr-2016-04-20 11:15:36 +0200
committerrr-2016-04-20 11:15:46 +0200
commit661c0248d2bfd0e34513a01eee1444b86eed6c86 (patch)
tree17ed8d19483dcb5f374599a1959de1987e9446a3 /API.md
parent9a4b5a7dd3c81ff05499fc6981cdec3505437135 (diff)
server/api: return snapshots to client
Diffstat (limited to 'API.md')
-rw-r--r--API.md83
1 files changed, 69 insertions, 14 deletions
diff --git a/API.md b/API.md
index 9400c6f..3c51c4f 100644
--- a/API.md
+++ b/API.md
@@ -142,10 +142,16 @@ data.
```json5
{
- "tagCategory": <tag-category>
+ "tagCategory": <tag-category>,
+ "snapshots": [
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag-category>` is a [tag category resource](#tag-category).
+ ...where `<tag-category>` is a [tag category resource](#tag-category), and
+ `snapshots` contain its earlier versions.
- **Errors**
@@ -178,10 +184,16 @@ data.
```json5
{
- "tagCategory": <tag-category>
+ "tagCategory": <tag-category>,
+ "snapshots": [
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag-category>` is a [tag category resource](#tag-category).
+ ...where `<tag-category>` is a [tag category resource](#tag-category), and
+ `snapshots` contain its earlier versions.
- **Errors**
@@ -207,10 +219,16 @@ data.
```json5
{
- "tagCategory": <tag-category>
+ "tagCategory": <tag-category>,
+ "snapshots": [
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-category-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag-category>` is a [tag category resource](#tag-category).
+ ...where `<tag-category>` is a [tag category resource](#tag-category), and
+ `snapshots` contain its earlier versions.
- **Errors**
@@ -351,10 +369,16 @@ data.
```json5
{
- "tag": <tag>
+ "tag": <tag>,
+ "snapshots": [
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag>` is a [tag resource](#tag).
+ ...where `<tag>` is a [tag resource](#tag), and `snapshots` contain its
+ earlier versions.
- **Errors**
@@ -399,10 +423,16 @@ data.
```json5
{
- "tag": <tag>
+ "tag": <tag>,
+ "snapshots": [
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag>` is a [tag resource](#tag).
+ ...where `<tag>` is a [tag resource](#tag), and `snapshots` contain its
+ earlier versions.
- **Errors**
@@ -435,10 +465,16 @@ data.
```json5
{
- "tag": <tag>
+ "tag": <tag>,
+ "snapshots": [
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>},
+ {"data": <tag-snapshot>, "time": <snapshot-time>}
+ ]
}
```
- ...where `<tag>` is a [tag resource](#tag).
+ ...where `<tag>` is a [tag resource](#tag), and `snapshots` contain its
+ earlier versions.
- **Errors**
@@ -768,7 +804,16 @@ data.
```json5
{
"name": "character",
- "color": "#FF0000", // used to colorize certain tag types in the web client
+ "color": "#FF0000" // used to colorize certain tag types in the web client
+}
+```
+
+## Tag category snapshot
+
+```json5
+{
+ "name": "character",
+ "color": "#FF0000"
}
```
@@ -777,7 +822,7 @@ data.
```json5
{
"names": ["tag1", "tag2", "tag3"],
- "category": "plain", // one of values controlled by server's configuration
+ "category": "plain",
"implications": ["implied-tag1", "implied-tag2", "implied-tag3"],
"suggestions": ["suggested-tag1", "suggested-tag2", "suggested-tag3"],
"creationTime": "2016-03-28T13:37:01.755461",
@@ -785,6 +830,16 @@ data.
}
```
+## Tag snapshot
+
+```json5
+{
+ "names": ["tag1", "tag2", "tag3"],
+ "category": "plain",
+ "implications": ["imp1", "imp2", "imp3"],
+ "suggestions": ["sug1", "sug2", "sug3"]
+}
+```
# Search

© 2015 - 2026 Jakob L. Kreuze