-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapplication.js
134 lines (126 loc) · 4.11 KB
/
application.js
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/**
* @api {get} application Get List
* @apiVersion 1.0.0
* @apiName GetApplicationList
* @apiGroup Application
*
* @apiDescription This will return a list of all applications you have created.
*
* @apiSuccess {Object[]} applicationList Array of all applications
* @apiSuccess {String} applicationList.id The application Id
* @apiSuccess {String} applicationList.name The name of the application
* @apiSuccess {Int} applicationList.createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "applicationList": [
* {
* "id": "systemId",
* "name": "YourName",
* "createStamp": "1234567890",
* },
* ...
* ]
* }
*/
/**
* @api {post} application Create
* @apiVersion 1.0.0
* @apiName PostApplication
* @apiGroup Application
*
* @apiDescription Create a application.
*
* @apiParam {String} name The name of the application
* @apiParam {String} [description] The description of the application
*
* @apiExample {json} Example post body (json):
* {
* "name": "DragonBall",
* "description": "The DragonBall application. This will contain feeds for all DragonBall characters."
* }
*
* @apiSuccess {String} id The application Id
* @apiSuccess {String} name The name of the application
* @apiSuccess {String} description The description of the application
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA786FDS87FDS78F6",
* "name": "DragonBall",
* "description": "The DragonBall application. This will contain feeds for all DragonBall characters.",
* "createStamp": "1415637736",
* }
*/
/**
* @api {get} application/:applicationId Get
* @apiVersion 1.0.0
* @apiName GetApplication
* @apiGroup Application
*
* @apiDescription This will return a specific application.
*
* @apiParam {String} applicationId The application id
*
* @apiSuccess {String} id The application Id
* @apiSuccess {String} name The name of the application
* @apiSuccess {String} description The description of the application
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA786FDS87FDS78F6",
* "name": "DragonBall",
* "description": "The DragonBall application. This will contain feeds for all DragonBall characters.",
* "createStamp": "1415637736",
* }
*/
/**
* @api {put} application/:applicationId Update
* @apiVersion 1.0.0
* @apiName PutApplication
* @apiGroup Application
*
* @apiDescription Update a specific application.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} name The name of the application
* @apiParam {String} [description] The description of the application
*
* @apiExample {json} Example post body (json):
* {
* "name": "DragonBall",
* "description": "The DragonBall application. This will contain feeds for all DragonBall characters."
* }
*
* @apiSuccess {String} id The application Id
* @apiSuccess {String} name The name of the application
* @apiSuccess {String} description The description of the application
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA786FDS87FDS78F6",
* "name": "DragonBall",
* "description": "The DragonBall application. This will contain feeds for all DragonBall characters.",
* "createStamp": "1415637736",
* }
*/
/**
* @api {delete} application/:applicationId Delete
* @apiVersion 1.0.0
* @apiName DeleteApplication
* @apiGroup Application
*
* @apiDescription Delete a specific application.
*
* @apiParam {String} applicationId The application id
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
*/