Accords-Library-Archive
/
gallery.accords-library.com
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/api: realign examples

This commit is contained in:
rr- 2016-08-06 22:20:34 +02:00
parent 3e77738c93
commit f4ea0d84ad
1 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
API.md
View File

@ -211,8 +211,8 @@ data.
```json5 ```json5
{ {
"name": <name>, // optional "name": <name>, // optional
"color": <color>, // optional "color": <color>, // optional
} }
``` ```
@ -380,9 +380,9 @@ data.
{ {
"names": [<name1>, <name2>, ...], "names": [<name1>, <name2>, ...],
"category": <category>, "category": <category>,
"description": <description>, // optional "description": <description>, // optional
"implications": [<name1>, <name2>, ...], // optional "implications": [<name1>, <name2>, ...], // optional
"suggestions": [<name1>, <name2>, ...] // optional "suggestions": [<name1>, <name2>, ...] // optional
} }
``` ```
@ -421,11 +421,12 @@ data.
```json5 ```json5
{ {
"names": [<name1>, <name2>, ...], // optional "version": <version>,
"category": <category>, // optional "names": [<name1>, <name2>, ...], // optional
"description": <description>, // optional "category": <category>, // optional
"implications": [<name1>, <name2>, ...], // optional "description": <description>, // optional
"suggestions": [<name1>, <name2>, ...] // optional "implications": [<name1>, <name2>, ...], // optional
"suggestions": [<name1>, <name2>, ...] // optional
} }
``` ```
@ -675,13 +676,13 @@ data.
```json5 ```json5
{ {
"tags": [<tag1>, <tag2>, <tag3>], "tags": [<tag1>, <tag2>, <tag3>],
"safety": <safety>, "safety": <safety>,
"source": <source>, // optional "source": <source>, // optional
"relations": [<post1>, <post2>, <post3>], // optional "relations": [<post1>, <post2>, <post3>], // optional
"notes": [<note1>, <note2>, <note3>], // optional "notes": [<note1>, <note2>, <note3>], // optional
"flags": [<flag1>, <flag2>], // optional "flags": [<flag1>, <flag2>], // optional
"anonymous": <anonymous> // optional "anonymous": <anonymous> // optional
} }
``` ```
@ -725,12 +726,12 @@ data.
```json5 ```json5
{ {
"tags": [<tag1>, <tag2>, <tag3>], // optional "tags": [<tag1>, <tag2>, <tag3>], // optional
"safety": <safety>, // optional "safety": <safety>, // optional
"source": <source>, // optional "source": <source>, // optional
"relations": [<post1>, <post2>, <post3>], // optional "relations": [<post1>, <post2>, <post3>], // optional
"notes": [<note1>, <note2>, <note3>], // optional "notes": [<note1>, <note2>, <note3>], // optional
"flags": [<flag1>, <flag2>] // optional "flags": [<flag1>, <flag2>] // optional
} }
``` ```
@ -976,8 +977,8 @@ data.
```json5 ```json5
{ {
"text": <text>, "text": <text>,
"postId": <post-id> "postId": <post-id>
} }
``` ```
@ -1004,7 +1005,7 @@ data.
```json5 ```json5
{ {
"text": <new-text> // mandatory "text": <new-text> // mandatory
} }
``` ```
@ -1148,10 +1149,10 @@ data.
```json5 ```json5
{ {
"name": <user-name>, "name": <user-name>,
"password": <user-password>, "password": <user-password>,
"email": <email>, // optional "email": <email>, // optional
"rank": <rank>, // optional "rank": <rank>, // optional
"avatarStyle": <avatar-style> // optional "avatarStyle": <avatar-style> // optional
} }
``` ```
@ -1193,10 +1194,10 @@ data.
```json5 ```json5
{ {
"name": <user-name>, // optional "name": <user-name>, // optional
"password": <user-password>, // optional "password": <user-password>, // optional
"email": <email>, // optional "email": <email>, // optional
"rank": <rank>, // optional "rank": <rank>, // optional
"avatarStyle": <avatar-style> // optional "avatarStyle": <avatar-style> // optional
} }
``` ```