Skip to content

Commit cbf6c1a

Browse files
committed
Expanding the API-Doc
1 parent 0e298d9 commit cbf6c1a

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

API.md

+42-4
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,60 @@ our Objects and their JSON, XML and YAML representation.
2222

2323
###Category
2424
Categories are used to tag the projects. Each category can have a parent, so
25-
a hierarchical category structure is possible.
25+
a hierarchical category structure is possible but currently limited to only one
26+
inheritance(?)
2627

2728
####JSON
28-
```JSON
29+
```json
2930
[{
3031
"id": 2412,
3132
"name": "german",
3233
"parent": 2315
3334
}]
3435
```
3536
####XML
36-
37+
```xml
38+
<root>
39+
<script/>
40+
<list-item>
41+
<id>2412</id>
42+
<name>german</name>
43+
<parent>2315</parent>
44+
</list-item>
45+
</root>
46+
```
3747
####YAML
38-
48+
```yaml
49+
- id: 2412
50+
name: german
51+
parent: 2315
52+
```
3953
4054
###Kind
55+
Kinds are used to determine to which broader category the
56+
57+
####JSON
58+
```json
59+
[{
60+
"id": 13,
61+
"name": "website"
62+
}]
63+
```
64+
####XML
65+
```xml
66+
<root>
67+
<script/>
68+
<list-item>
69+
<id>13</id>
70+
<name>website</name>
71+
</list-item>
72+
</root>
73+
```
74+
####YAML
75+
```yaml
76+
- id: 13
77+
name: website
78+
```
4179
4280
###Language
4381

0 commit comments

Comments
 (0)