-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathentry.js
248 lines (234 loc) · 8.05 KB
/
entry.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/**
* @api {get} application/:applicationId/feed/:feedId/entry Get List (Feed)
* @apiVersion 1.0.0
* @apiName GetEntryListFeed
* @apiGroup Entry
*
* @apiDescription This will return a list of all entries per feed you have created.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} feedId The application id
*
* @apiSuccess {Object} feed
* @apiSuccess {String} feed.id The application Id
* @apiSuccess {String} feed.name The name of the application
* @apiSuccess {String} feed.channelId The channel Id of the feed
* @apiSuccess {String} feed.applicationId The id of the application the feed belongs to
* @apiSuccess {Int} feed.createStamp Unix time stamp of create time
* @apiSuccess {Object[]} entryList Array of all entries
* @apiSuccess {String} entryList.id The entry Id
* @apiSuccess {Int} entryList.createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "feed": {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "name": "Son Goku",
* "channelId": "ASJDH86ASD678ASDASD768",
* "applicationId": "KAJFDA786FDS87FDS78F6",
* "createStamp": "1415637736",
* }
* "entryList": [
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "createStamp": "1415637736",
* },
* ...
* ]
* }
*/
/**
* @api {post} application/:applicationId/entry Create
* @apiVersion 1.0.0
* @apiName PostEntry
* @apiGroup Entry
*
* @apiDescription Create a entry on the global feed. This could be used to store a element in the cloud system and re-use it later.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} data The data of the entry
* @apiParam {String[]} [tagList] Tags of the entry
*
* @apiSuccess {String} id The feed Id
* @apiSuccess {String} applicationId The application id
* @apiSuccess {String} data The data of the entry
* @apiSuccess {String[]} tagList List of set tags
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "applicationId": "KAJDFE7GFTRE87FDS78F7",
* "data": "Hello, I'm Son Gocu and this is my first post.",
* "tagList": [
* "First",
* "Awesome"
* ],
* "createStamp": "1415637736",
* }
*/
/**
* @api {post} application/:applicationId/feed/:feedId/entry Create (Feed)
* @apiVersion 1.0.0
* @apiName PostEntryFeed
* @apiGroup Entry
*
* @apiDescription Create a entry in the global feed and link it automatically to a feed.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} feedId The feed id
* @apiParam {String} data The data of the entry
* @apiParam {String[]} [tagList] Tags of the entry
*
* @apiSuccess {String} id The feed Id
* @apiSuccess {String} applicationId The application id
* @apiSuccess {String} feedId The feed id
* @apiSuccess {String} data The data of the entry
* @apiSuccess {String[]} tagList List of set tags
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "applicationId": "KAJDFE7GFTRE87FDS78F7",
* "feedId": "KAJDFE7GFTRE87FDS78F7",
* "data": "Hello, I'm Son Gocu and this is my first post.",
* "tagList": [
* "First",
* "Awesome"
* ],
* "createStamp": "1415637736",
* }
*/
/**
* @api {post} application/:applicationId/feed/:feedId/entry/ Add (Feed)
* @apiVersion 1.0.0
* @apiName PostEntryFeedAdd
* @apiGroup Entry
*
* @apiDescription Add a entry by entry Id to the feed which is already store in the system.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} feedId The feed id
* @apiParam {String} entryId The entry id
*
* @apiSuccess {String} id The feed Id
* @apiSuccess {String} applicationId The application id
* @apiSuccess {String} feedId The feed id
* @apiSuccess {String} data The data of the entry
* @apiSuccess {String[]} tagList List of set tags
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "applicationId": "KAJDFE7GFTRE87FDS78F7",
* "feedId": "KAJDFE7GFTRE87FDS78F7",
* "data": "Hello, I'm Son Gocu and this is my first post.",
* "tagList": [
* "First",
* "Awesome"
* ],
* "createStamp": "1415637736",
* }
*/
/**
* @api {get} application/:applicationId/feed/:feedId/entry/:entryId Get (Feed)
* @apiVersion 1.0.0
* @apiName GetEntryFeed
* @apiGroup Entry
*
* @apiDescription This will return a specific entry.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} feedId The feed id
* @apiParam {String} entryId The entry id
*
* @apiSuccess {String} id The feed Id
* @apiSuccess {String} applicationId The application id
* @apiSuccess {String} feedId The feed id
* @apiSuccess {String} data The data of the entry
* @apiSuccess {String[]} tagList List of set tags
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "applicationId": "KAJDFE7GFTRE87FDS78F7",
* "feedId": "KAJDFE7GFTRE87FDS78F7",
* "data": "Hello, I'm Son Gocu and this is my first post.",
* "tagList": [
* "First",
* "Awesome"
* ],
* "createStamp": "1415637736",
* }
*/
/**
* @api {put} application/:applicationId/entry/:entryId Update
* @apiVersion 1.0.0
* @apiName PutEntry
* @apiGroup Entry
*
* @apiDescription Update a specific entry.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} entryId The entry id
* @apiParam {String} data The data of the entry
* @apiParam {String[]} [tagList] Tags of the entry
*
* @apiSuccess {String} id The feed Id
* @apiSuccess {String} applicationId The application id
* @apiSuccess {String} [feedId] The feed id
* @apiSuccess {String} data The data of the entry
* @apiSuccess {String[]} tagList List of set tags
* @apiSuccess {Int} createStamp Unix time stamp of create time
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": "KAJFDA7GFTRE87FDS78F7",
* "applicationId": "KAJDFE7GFTRE87FDS78F7",
* "feedId": "KAJDFE7GFTRE87FDS78F7",
* "data": "Hello, I'm Son Gocu and this is my first post.",
* "tagList": [
* "First",
* "Awesome"
* ],
* "createStamp": "1415637736",
* }
*/
/**
* @api {delete} application/:applicationId/entry/:entryId Delete
* @apiVersion 1.0.0
* @apiName DeleteEntry
* @apiGroup Entry
*
* @apiDescription Delete a specific entry. (will also remove the entry from all feeds)
*
* @apiParam {String} applicationId The application id
* @apiParam {String} entryId The entry id
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
*/
/**
* @api {delete} application/:applicationId/feed/:feedId/entry/:entryId Remove (Feed)
* @apiVersion 1.0.0
* @apiName RemoveEntry
* @apiGroup Entry
*
* @apiDescription Removes a specific entry from a feed.
*
* @apiParam {String} applicationId The application id
* @apiParam {String} feedId The feed id
* @apiParam {String} entryId The entry id
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
*/