summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorneobooru <50623835+neobooru@users.noreply.github.com>2020-09-23 13:49:20 +0200
committerneobooru <50623835+neobooru@users.noreply.github.com>2020-09-23 13:49:20 +0200
commitb5d2e447fc3f40050516e9ef9879ebe2008dd4d2 (patch)
tree5d28423f76f6719438d0fa79dae7387290b4432e /doc
parentd2b6ecef4d0434aa6315e20a322991477f084ca8 (diff)
docs: update tag category api
Diffstat (limited to 'doc')
-rw-r--r--doc/API.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/API.md b/doc/API.md
index 11f2d5b..cccbc4e 100644
--- a/doc/API.md
+++ b/doc/API.md
@@ -321,7 +321,8 @@ data.
```json5
{
"name": <name>,
- "color": <color>
+ "color": <color>,
+ "order": <order> // optional
}
```
@@ -354,6 +355,7 @@ data.
"version": <version>,
"name": <name>, // optional
"color": <color>, // optional
+ "order": <order> // optional
}
```
@@ -2288,7 +2290,8 @@ experience.
"version": <version>,
"name": <name>,
"color": <color>,
- "usages": <usages>
+ "usages": <usages>,
+ "order": <order>,
"default": <is-default>
}
```
@@ -2299,6 +2302,7 @@ experience.
- `<name>`: the category name.
- `<color>`: the category color.
- `<usages>`: how many tags is the given category used with.
+- `<order>`: the order in which tags with this category are displayed, ascending.
- `<is-default>`: whether the tag category is the default one.
## Tag
@@ -2498,7 +2502,7 @@ experience.
"version": <version>,
"name": <name>,
"color": <color>,
- "usages": <usages>
+ "usages": <usages>,
"default": <is-default>
}
```
@@ -2712,7 +2716,7 @@ dictionaries as created by creation snapshots, which is described below.
},
"primitive-property":
{
- "type": "primitive change":
+ "type": "primitive change",
"old-value": "<primitive>",
"new-value": "<primitive>"
},