docoGen-script-example/web-ext-api.docogen at master · toolbuddy/docoGen-script-example · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "article": [
        {
            "title": "Web extension",
            "priority": 7,
            "content": [
                {
                    "name": "Restful Api support",
                    "type": "web-restful-api",
                    "data": [
                        {
                            "method": "post",
                            "usage": "[Online] Register New User",
                            "url": "https://kevin.imslab.org/register",
                            "description": "Enroll new user to local service",
                            "field": [
                                { "name": "username","type": "String" },{"name":"password","type":"String"},{"name":"email","type":"String"}
                            ],
                            "error": [
                                "duplicated", "internal error"
                            ],
                            "success": [
                                "success"
                            ]
                        },
                        {
                            "method": "get",
                            "usage": "[Online] Checking mail",
                            "url": "https://kevin.imslab.org/checkmail",
                            "description": "Enroll new user to local service",
                            "field": [
                                { "name": "email","type": "String" }
                            ],
                            "error": [
                                "internal error"
                            ],
                            "success": [
                                "existed", "not found"
                            ]
                        }
                    ],
                    "figure": [
                    ],
                    "subarticle": [
                    ]
                }
            ]
        }
    ]
}