Skip to content

Commit eaec2f1

Browse files
committed
Added datadoc, ready for version 0.6
1 parent 36c5b2a commit eaec2f1

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

docs/datadoc.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Quicktable Datamodel
2+
3+
### Models
4+
5+
**Keyspace/Valueset:**
6+
Represents a set of either keys or values.
7+
8+
```json
9+
["mammalia", "carnivora", "felidae", "felis"]
10+
```
11+
12+
**Value:**
13+
Represents a single value.
14+
15+
```json
16+
"felis"
17+
```
18+
19+
**Key:**
20+
Represents a reduced keyspace.
21+
22+
```json
23+
"mammalia:carnivora:felidae:felis"
24+
```
25+
26+
### Forms
27+
28+
**Keys form:**
29+
A key exclusive form.
30+
31+
```json
32+
{
33+
"keys": ["mammalia", "carnivora", "felidae", "felis"]
34+
}
35+
```
36+
37+
**Regular form:**
38+
A regular key/value form.
39+
40+
```json
41+
{
42+
"keys": ["mammalia", "carnivora", "felidae"],
43+
"values": ["felis"]
44+
}
45+
```
46+
47+
**Report form:**
48+
A reporting form, where `T` can be any other model or form.
49+
50+
```json
51+
{
52+
"failed": false,
53+
"mesg": "",
54+
"data": T
55+
}
56+
```

0 commit comments

Comments
 (0)