From f4ea0d84ad7a3b121d0149e136483a713d6f65c8 Mon Sep 17 00:00:00 2001 From: rr- Date: Sat, 6 Aug 2016 22:20:34 +0200 Subject: [PATCH] docs/api: realign examples --- API.md | 69 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 35 insertions(+), 34 deletions(-) diff --git a/API.md b/API.md index 3eb3d96..8c62313 100644 --- a/API.md +++ b/API.md @@ -211,8 +211,8 @@ data. ```json5 { - "name": , // optional - "color": , // optional + "name": , // optional + "color": , // optional } ``` @@ -380,9 +380,9 @@ data. { "names": [, , ...], "category": , - "description": , // optional - "implications": [, , ...], // optional - "suggestions": [, , ...] // optional + "description": , // optional + "implications": [, , ...], // optional + "suggestions": [, , ...] // optional } ``` @@ -421,11 +421,12 @@ data. ```json5 { - "names": [, , ...], // optional - "category": , // optional - "description": , // optional - "implications": [, , ...], // optional - "suggestions": [, , ...] // optional + "version": , + "names": [, , ...], // optional + "category": , // optional + "description": , // optional + "implications": [, , ...], // optional + "suggestions": [, , ...] // optional } ``` @@ -675,13 +676,13 @@ data. ```json5 { - "tags": [, , ], - "safety": , - "source": , // optional - "relations": [, , ], // optional - "notes": [, , ], // optional - "flags": [, ], // optional - "anonymous": // optional + "tags": [, , ], + "safety": , + "source": , // optional + "relations": [, , ], // optional + "notes": [, , ], // optional + "flags": [, ], // optional + "anonymous": // optional } ``` @@ -725,12 +726,12 @@ data. ```json5 { - "tags": [, , ], // optional - "safety": , // optional - "source": , // optional - "relations": [, , ], // optional - "notes": [, , ], // optional - "flags": [, ] // optional + "tags": [, , ], // optional + "safety": , // optional + "source": , // optional + "relations": [, , ], // optional + "notes": [, , ], // optional + "flags": [, ] // optional } ``` @@ -976,8 +977,8 @@ data. ```json5 { - "text": , - "postId": + "text": , + "postId": } ``` @@ -1004,7 +1005,7 @@ data. ```json5 { - "text": // mandatory + "text": // mandatory } ``` @@ -1148,10 +1149,10 @@ data. ```json5 { - "name": , - "password": , - "email": , // optional - "rank": , // optional + "name": , + "password": , + "email": , // optional + "rank": , // optional "avatarStyle": // optional } ``` @@ -1193,10 +1194,10 @@ data. ```json5 { - "name": , // optional - "password": , // optional - "email": , // optional - "rank": , // optional + "name": , // optional + "password": , // optional + "email": , // optional + "rank": , // optional "avatarStyle": // optional } ```