Completed
Push — master ( f65d8f...4f3de5 )
by Pavel
04:14 queued 01:54
created

app/_apidoc.js   A

Complexity

Total Complexity 0
Complexity/F 0

Size

Lines of Code 1
Function Count 0

Duplication

Duplicated Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 0
nc 1
dl 0
loc 1
rs 10
c 1
b 0
f 1
wmc 0
mnd 0
bc 0
fnc 0
bpm 0
cpm 0
noi 0
1
/**
2
 * @apiDefine UnauthorizedError
3
 *
4
 * @apiSuccessExample {json} Не авторизован (401)
5
 *     HTTP/1.1 401 Unauthorized
6
 *     {
7
 *       "errors": [
8
 *         {
9
 *           "status": "401",
10
 *           "code": "401",
11
 *           "title": "Not authorized",
12
 *           "detail": "The user must be authorized"
13
 *         }
14
 *       ]
15
 *     }
16
 */
17
18
/**
19
 * @apiDefine StandardErrors
20
 *
21
 * @apiSuccessExample {json} Неверный запрос (400)
22
 *     HTTP/1.1 400 Unauthorized
23
 *     {
24
 *       "errors": [
25
 *         {
26
 *           "id": "user",
27
 *           "status": "400",
28
 *           "code": "400",
29
 *           "title": "Invalid Attribute",
30
 *           "detail": "Not required attributes - data."
31
 *         }
32
 *       ]
33
 *     }
34
 * @apiSuccessExample {json} Ошибка сервера (500)
35
 *     HTTP/1.1 500 Internal Server Error
36
 *     {
37
 *       "errors": [
38
 *         {
39
 *           "status": "500",
40
 *           "code": "500",
41
 *           "title": "Internal server error",
42
 *           "detail": "Internal server error"
43
 *         }
44
 *       ]
45
 *     }
46
 */
47
48
/**
49
 * @apiDefine NotFoundError
50
 *
51
 * @apiSuccessExample {json} Не найдено (404)
52
 *     HTTP/1.1 404 Not found
53
 *     {
54
 *       "errors": [
55
 *         {
56
 *           "status": "404",
57
 *            "code": "404",
58
 *            "title": "Not found",
59
 *           "detail": "Entities not found"
60
 *         }
61
 *       ]
62
 *     }
63
 */
64
65
/**
66
 * @apiDefine Filter
67
 *
68
 *
69
 */