-
Notifications
You must be signed in to change notification settings - Fork 0
/
template_apib.html
432 lines (397 loc) · 39.7 KB
/
template_apib.html
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<!DOCTYPE html><html><head><meta charset="utf-8"><title>ProjectName API Specification</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#000;background-color:#337ab7}.action h4.action-heading .method.head{color:#000;background-color:#337ab7}.action h4.action-heading .method.options{color:#000;background-color:#337ab7}.action h4.action-heading .method.put{color:#000;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#000;background-color:#ed9c28}.action h4.action-heading .method.post{color:#000;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#000;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-introduction">Introduction</a></li><li><a href="#header-rest">REST</a></li><li><a href="#header-convetions">Convetions</a></li><li><a href="#header-endpoints">Endpoints</a></li><li><a href="#header-staging-environment">Staging Environment</a></li><li><a href="#header-production-environment">Production Environment</a></li><li><a href="#header-versioning">Versioning</a></li><li><a href="#header-localization">Localization</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-errors">Errors</a></li><li><a href="#header-pagination">Pagination</a></li><li><a href="#header-ordering">Ordering</a></li><li><a href="#header-filtering">Filtering</a></li><li><a href="#header-response-codes">Response codes</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#use-cases">Use Cases</a></div><div class="collapse-content"><ul></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#authentication-1">Authentication</a></div><div class="collapse-content"><ul><li><a href="#authentication-social-networks-post"><span class="badge post"><i class="fa fa-plus"></i></span>Authentication via Facebook</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#users-&-profiles">Users & Profiles</a></div><div class="collapse-content"><ul><li><a href="#users-&-profiles-users-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get users</a></li><li><a href="#users-&-profiles-users-devices-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get user devices</a></li></ul></div></div></nav><div class="content"><header><h1 id="top">ProjectName API Specification</h1></header><h2 id="header-introduction">Introduction <a class="permalink" href="#header-introduction" aria-hidden="true">¶</a></h2>
<h3 id="header-rest">REST <a class="permalink" href="#header-rest" aria-hidden="true">¶</a></h3>
<p>API design is REST based.</p>
<h3 id="header-convetions">Convetions <a class="permalink" href="#header-convetions" aria-hidden="true">¶</a></h3>
<p><em>Date Format Convention</em><br>
<em>Other conventions if exist</em></p>
<h2 id="header-endpoints">Endpoints <a class="permalink" href="#header-endpoints" aria-hidden="true">¶</a></h2>
<h4 id="header-staging-environment">Staging Environment <a class="permalink" href="#header-staging-environment" aria-hidden="true">¶</a></h4>
<pre><code><span class="hljs-string">https:</span><span class="hljs-comment">//projecturl.staging/api/</span></code></pre>
<h4 id="header-production-environment">Production Environment <a class="permalink" href="#header-production-environment" aria-hidden="true">¶</a></h4>
<pre><code><span class="hljs-string">https:</span><span class="hljs-comment">//projecturl.production/api/</span></code></pre>
<h2 id="header-versioning">Versioning <a class="permalink" href="#header-versioning" aria-hidden="true">¶</a></h2>
<p>Current API version is <code>v1</code>.<br>
Version of the API should be explicitly set in the URL.</p>
<p>Example:</p>
<pre><code>/<span class="hljs-literal">v1</span>/users/</code></pre>
<h2 id="header-localization">Localization <a class="permalink" href="#header-localization" aria-hidden="true">¶</a></h2>
<p>Set <code>Accept-Language</code> header for receiving localized strings in response.<br>
Default language is English.</p>
<h2 id="header-authentication">Authentication <a class="permalink" href="#header-authentication" aria-hidden="true">¶</a></h2>
<p><em>Describe how authentication works in general.</em></p>
<h2 id="header-errors">Errors <a class="permalink" href="#header-errors" aria-hidden="true">¶</a></h2>
<p><code>4xx</code> errors are client errors, so the only way to handle them is to validate input data and repeat request.<br>
<code>5xx</code> errors are server errors and should be handled with repeated requests.</p>
<p>Error format:</p>
<pre><code class="language-js">{
# error code, string
"error": "auth_facebook_token_invalid",
# localized user-friendly message
"message": "Hey! I am localized and useful message!",
# additional details
"misc": "Some error details if needed"
}</code></pre>
<h2 id="header-pagination">Pagination <a class="permalink" href="#header-pagination" aria-hidden="true">¶</a></h2>
<p>Cursor pagination is used for collections methods. This means that every paginated request should have <code>ID</code> of current resource in <code>GET</code> array. If <code>ID</code> is provided, resources are sliced after it, if no - resources getting from the beginning. If method supports pagination, it always returns response in such format:</p>
<pre><code class="language-js">{
“pagination”: {
“next”: <span class="xml"><span class="hljs-tag"><<span class="hljs-title">next_page_url</span>></span>,
“prev”: <span class="hljs-tag"><<span class="hljs-title">prev_page_url</span>></span>,
},
“results”: [
<span class="hljs-tag"><<span class="hljs-title">list</span> <span class="hljs-attribute">of</span> <span class="hljs-attribute">models</span>></span>
]</span>
}</code></pre>
<p>To specify cursor, <code>?cursor=</code> should be added to query, but the easier way is to follow <code>next</code> or <code>prev</code> urls.
If there is no next or previous page available, it’s code will be <code>null</code> in response.<br>
Results by default are paginated by 10 models. To change it, supply <code>?limit=</code> query parameter with required value, but no more then 50.<br>
Pagination stacks with searching and ordering options in this order: search => ordering => pagination</p>
<p>Example:</p>
<pre><code class="language-js">GET /users?cursor=<span class="hljs-number">1</span>d4737b998d64a0894a322ff7cf39a29&limit=<span class="hljs-number">11</span></code></pre>
<h2 id="header-ordering">Ordering <a class="permalink" href="#header-ordering" aria-hidden="true">¶</a></h2>
<p>Ascending order has no prefix before parameter name.<br>
Descending order has <code>-</code> (minus) prefix before parameter name.<br>
For multiple fields ordering, they should be specified in comma-separated list, order makes sense.<br>
For nested ordering use <code>__</code> (double underscore) as separator.</p>
<p>Examples:</p>
<pre><code class="language-js"># ascending order
GET /posts/?ordering=created_at
# descending order
GET /posts/?ordering=-created_at
# ordered by user’s username, then by created_at in descending order
GET /posts/?ordering=owner__username,-created_at (</code></pre>
<p>Supported fields for ordering noted at particular methods definition.</p>
<h2 id="header-filtering">Filtering <a class="permalink" href="#header-filtering" aria-hidden="true">¶</a></h2>
<p>Supported fields for filtering noted at particular methods definition.</p>
<p>Example:</p>
<pre><code class="language-js">GET /users/?search=sergey</code></pre>
<h2 id="header-response-codes">Response codes <a class="permalink" href="#header-response-codes" aria-hidden="true">¶</a></h2>
<table>
<thead>
<tr>
<th>Code</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>Everything is ok</td>
</tr>
<tr>
<td>201</td>
<td>Resource created successfully</td>
</tr>
<tr>
<td>204</td>
<td>Resource deleted successfully</td>
</tr>
<tr>
<td>400</td>
<td>Incorrect data provided</td>
</tr>
<tr>
<td>401</td>
<td>Authorization is not provided or contains wrong (or expired) token. Re-authorization required.</td>
</tr>
<tr>
<td>403</td>
<td>Resource is forbidden for user</td>
</tr>
<tr>
<td>404</td>
<td>Resource not found</td>
</tr>
<tr>
<td>405</td>
<td>Method not allowed</td>
</tr>
<tr>
<td>500</td>
<td>Unhandled server error.</td>
</tr>
<tr>
<td>503</td>
<td>Service is down</td>
</tr>
<tr>
<td>504</td>
<td>Gateway timeout. Service is overloaded or some other problem exists.</td>
</tr>
</tbody>
</table>
<section id="use-cases" class="resource-group"><h2 class="group-heading">Use Cases <a href="#use-cases" class="permalink">¶</a></h2><p><em>Some cases can involve more that just one API method, describe such cases here.</em></p>
</section><section id="authentication-1" class="resource-group"><h2 class="group-heading">Authentication <a href="#authentication-1" class="permalink">¶</a></h2><div id="authentication-social-networks" class="resource"><h3 class="resource-heading">Social Networks <a href="#authentication-social-networks" class="permalink"> ¶</a></h3><div id="authentication-social-networks-post" class="action post"><h4 class="action-heading"><div class="name">Authentication via Facebook</div><a href="#authentication-social-networks-post" class="method post">POST</a><code class="uri">/authenticate/</code></h4><h4 id="header-body-parameters-">Body Parameters: <a class="permalink" href="#header-body-parameters-" aria-hidden="true">¶</a></h4>
<ul>
<li><code>facebook_token</code> — token obtained from Facebook</li>
</ul>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/authenticate/</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Accept-Language</span>: <span class="hljs-string">en-gb</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">facebook_token</span>": <span class="hljs-value"><span class="hljs-string">"EAACzJrZC2Ja4B23423dTsGGYyMQZCmOZCjXW7VDDDH65BJ6oBIpg4lpYouR9MWYzZCsEKJvCTDIJMy4ewZCwPyufEstDoj0v5ZB8gAl2oqGyZAqI7ex7iEtkQ5wTfXso1F1nbjpMpMbd5LzRzm8zNP1ZABoW1pl8PiAHDZBE3cAZDZD"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">access_token</span>" : <span class="hljs-value"><span class="hljs-string">"27e4c22bab96097sdf3234e55074ae1ff11"</span></span>,
"<span class="hljs-attribute">user</span>" : <span class="hljs-value">{
"<span class="hljs-attribute">id</span>" : <span class="hljs-value"><span class="hljs-string">"8b783089-0d80-4ed8-896e-b78964abef85"</span></span>,
"<span class="hljs-attribute">image_url</span>" : <span class="hljs-value"><span class="hljs-string">"http://previews.123rf.com/images/kritchanut/kritchanut1406/kritchanut140600093/29213195-Male-silhouette-avatar-profile-picture-Stock-Vector.jpg"</span></span>,
"<span class="hljs-attribute">type</span>" : <span class="hljs-value"><span class="hljs-string">"regular"</span></span>,
"<span class="hljs-attribute">username</span>" : <span class="hljs-value"><span class="hljs-string">"John Doe"</span></span>,
}
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="users-&-profiles" class="resource-group"><h2 class="group-heading">Users & Profiles <a href="#users-&-profiles" class="permalink">¶</a></h2><div id="users-&-profiles-users-collection" class="resource"><h3 class="resource-heading">Users collection <a href="#users-&-profiles-users-collection" class="permalink"> ¶</a></h3><div id="users-&-profiles-users-collection-get" class="action get"><h4 class="action-heading"><div class="name">Get users</div><a href="#users-&-profiles-users-collection-get" class="method get">GET</a><code class="uri">/users/</code></h4><h4 id="header-ordering-fields">Ordering fields <a class="permalink" href="#header-ordering-fields" aria-hidden="true">¶</a></h4>
<ul>
<li>
<p><code>username</code> (default)</p>
</li>
<li>
<p><code>votes_count</code></p>
</li>
<li>
<p><code>followers_count</code></p>
</li>
</ul>
<h4 id="header-search-fields">Search fields <a class="permalink" href="#header-search-fields" aria-hidden="true">¶</a></h4>
<ul>
<li><code>username</code></li>
</ul>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/users/</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Token 27e4c22bab96597c0b6cbcb0af4e55074ae1ff11</span><br><span class="hljs-attribute">Accept-Language</span>: <span class="hljs-string">en-gb</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">next</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">previous</span>": <span class="hljs-value"><span class="hljs-literal">null</span>
</span>}</span>,
"<span class="hljs-attribute">results</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"8b783089-3142-4ed8-896e-b78964abef85"</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"john.doe"</span></span>,
"<span class="hljs-attribute">is_username_set</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">image_url</span>": <span class="hljs-value"><span class="hljs-string">"https://scontent.xx.fbcdn.net/v/t1.0-1/s320x320/52091_10203905252368631_281704847006585_n.jpg?oh=7261785ceb5d4b10a5a9c6eef21b53f&oe=58F075B1"</span></span>,
"<span class="hljs-attribute">facebook_id</span>": <span class="hljs-value"><span class="hljs-string">"123121231231"</span></span>,
"<span class="hljs-attribute">google_id</span>": <span class="hljs-value"><span class="hljs-string">"10208036482846485"</span></span>,
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"regular"</span></span>,
"<span class="hljs-attribute">followed_by_me</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">followers_count</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">following_count</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
"<span class="hljs-attribute">posts_count</span>": <span class="hljs-value"><span class="hljs-number">0</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"083dfec3-3a0e-40fe-bcfa-0174f961a12d"</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"john.doe.1"</span></span>,
"<span class="hljs-attribute">is_username_set</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">image_url</span>": <span class="hljs-value"><span class="hljs-string">"https://scontent.xx.fbcdn.net/v/t1.0-1/p320x320/3123121_12315124185755_83322151572584_n.jpg?oh=16f121567814322918c6d99ec3e1a5&oe=58AFE60D"</span></span>,
"<span class="hljs-attribute">facebook_id</span>": <span class="hljs-value"><span class="hljs-string">"234121242123"</span></span>,
"<span class="hljs-attribute">google_id</span>": <span class="hljs-value"><span class="hljs-string">"10208036482846485"</span></span>,
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"regular"</span></span>,
"<span class="hljs-attribute">followed_by_me</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">followers_count</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>,
"<span class="hljs-attribute">following_count</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">posts_count</span>": <span class="hljs-value"><span class="hljs-number">0</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="users-&-profiles-users-devices-collection" class="resource"><h3 class="resource-heading">Users devices collection <a href="#users-&-profiles-users-devices-collection" class="permalink"> ¶</a></h3><div id="users-&-profiles-users-devices-collection-get" class="action get"><h4 class="action-heading"><div class="name">Get user devices</div><a href="#users-&-profiles-users-devices-collection-get" class="method get">GET</a><code class="uri">/users/devices/</code></h4><h4 id="header-ordering-fields-1">Ordering fields <a class="permalink" href="#header-ordering-fields-1" aria-hidden="true">¶</a></h4>
<ul>
<li><code>created_at</code> (default)</li>
</ul>
<h4 id="header-search-fields-1">Search fields <a class="permalink" href="#header-search-fields-1" aria-hidden="true">¶</a></h4>
<ul>
<li><code>device_name</code></li>
</ul>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/users/devices/</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Token 27e4c22bab96597c0b6cbcb0af4e55074ae1ff11</span><br><span class="hljs-attribute">Accept-Language</span>: <span class="hljs-string">en-gb</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
<span class="hljs-string">"pagination"</span>: {
<span class="hljs-string">"next"</span>: <span class="hljs-literal">null</span>,
<span class="hljs-string">"previous"</span>: <span class="hljs-literal">null</span>
},
<span class="hljs-string">"results"</span>: [
{
...
}
]
}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 19 Sep 2017</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
/*
Determine if a string ends with another string.
*/
function endsWith(str, suffix) {
return str.indexOf(suffix, str.length - suffix.length) !== -1;
}
/*
Get a list of direct child elements by class name.
*/
function childrenByClass(element, name) {
var filtered = [];
for (var i = 0; i < element.children.length; i++) {
var child = element.children[i];
var classNames = child.className.split(' ');
if (classNames.indexOf(name) !== -1) {
filtered.push(child);
}
}
return filtered;
}
/*
Get an array [width, height] of the window.
*/
function getWindowDimensions() {
var w = window,
d = document,
e = d.documentElement,
g = d.body,
x = w.innerWidth || e.clientWidth || g.clientWidth,
y = w.innerHeight || e.clientHeight || g.clientHeight;
return [x, y];
}
/*
Collapse or show a request/response example.
*/
function toggleCollapseButton(event) {
var button = event.target.parentNode;
var content = button.parentNode.nextSibling;
var inner = content.children[0];
if (button.className.indexOf('collapse-button') === -1) {
// Clicked without hitting the right element?
return;
}
if (content.style.maxHeight && content.style.maxHeight !== '0px') {
// Currently showing, so let's hide it
button.className = 'collapse-button';
content.style.maxHeight = '0px';
} else {
// Currently hidden, so let's show it
button.className = 'collapse-button show';
content.style.maxHeight = inner.offsetHeight + 12 + 'px';
}
}
function toggleTabButton(event) {
var i, index;
var button = event.target;
// Get index of the current button.
var buttons = childrenByClass(button.parentNode, 'tab-button');
for (i = 0; i < buttons.length; i++) {
if (buttons[i] === button) {
index = i;
button.className = 'tab-button active';
} else {
buttons[i].className = 'tab-button';
}
}
// Hide other tabs and show this one.
var tabs = childrenByClass(button.parentNode.parentNode, 'tab');
for (i = 0; i < tabs.length; i++) {
if (i === index) {
tabs[i].style.display = 'block';
} else {
tabs[i].style.display = 'none';
}
}
}
/*
Collapse or show a navigation menu. It will not be hidden unless it
is currently selected or `force` has been passed.
*/
function toggleCollapseNav(event, force) {
var heading = event.target.parentNode;
var content = heading.nextSibling;
var inner = content.children[0];
if (heading.className.indexOf('heading') === -1) {
// Clicked without hitting the right element?
return;
}
if (content.style.maxHeight && content.style.maxHeight !== '0px') {
// Currently showing, so let's hide it, but only if this nav item
// is already selected. This prevents newly selected items from
// collapsing in an annoying fashion.
if (force || window.location.hash && endsWith(event.target.href, window.location.hash)) {
content.style.maxHeight = '0px';
}
} else {
// Currently hidden, so let's show it
content.style.maxHeight = inner.offsetHeight + 12 + 'px';
}
}
/*
Refresh the page after a live update from the server. This only
works in live preview mode (using the `--server` parameter).
*/
function refresh(body) {
document.querySelector('body').className = 'preload';
document.body.innerHTML = body;
// Re-initialize the page
init();
autoCollapse();
document.querySelector('body').className = '';
}
/*
Determine which navigation items should be auto-collapsed to show as many
as possible on the screen, based on the current window height. This also
collapses them.
*/
function autoCollapse() {
var windowHeight = getWindowDimensions()[1];
var itemsHeight = 64; /* Account for some padding */
var itemsArray = Array.prototype.slice.call(
document.querySelectorAll('nav .resource-group .heading'));
// Get the total height of the navigation items
itemsArray.forEach(function (item) {
itemsHeight += item.parentNode.offsetHeight;
});
// Should we auto-collapse any nav items? Try to find the smallest item
// that can be collapsed to show all items on the screen. If not possible,
// then collapse the largest item and do it again. First, sort the items
// by height from smallest to largest.
var sortedItems = itemsArray.sort(function (a, b) {
return a.parentNode.offsetHeight - b.parentNode.offsetHeight;
});
while (sortedItems.length && itemsHeight > windowHeight) {
for (var i = 0; i < sortedItems.length; i++) {
// Will collapsing this item help?
var itemHeight = sortedItems[i].nextSibling.offsetHeight;
if ((itemsHeight - itemHeight <= windowHeight) || i === sortedItems.length - 1) {
// It will, so let's collapse it, remove its content height from
// our total and then remove it from our list of candidates
// that can be collapsed.
itemsHeight -= itemHeight;
toggleCollapseNav({target: sortedItems[i].children[0]}, true);
sortedItems.splice(i, 1);
break;
}
}
}
}
/*
Initialize the interactive functionality of the page.
*/
function init() {
var i, j;
// Make collapse buttons clickable
var buttons = document.querySelectorAll('.collapse-button');
for (i = 0; i < buttons.length; i++) {
buttons[i].onclick = toggleCollapseButton;
// Show by default? Then toggle now.
if (buttons[i].className.indexOf('show') !== -1) {
toggleCollapseButton({target: buttons[i].children[0]});
}
}
var responseCodes = document.querySelectorAll('.example-names');
for (i = 0; i < responseCodes.length; i++) {
var tabButtons = childrenByClass(responseCodes[i], 'tab-button');
for (j = 0; j < tabButtons.length; j++) {
tabButtons[j].onclick = toggleTabButton;
// Show by default?
if (j === 0) {
toggleTabButton({target: tabButtons[j]});
}
}
}
// Make nav items clickable to collapse/expand their content.
var navItems = document.querySelectorAll('nav .resource-group .heading');
for (i = 0; i < navItems.length; i++) {
navItems[i].onclick = toggleCollapseNav;
// Show all by default
toggleCollapseNav({target: navItems[i].children[0]});
}
}
// Initial call to set up buttons
init();
window.onload = function () {
autoCollapse();
// Remove the `preload` class to enable animations
document.querySelector('body').className = '';
};
</script></body></html>