-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
379 lines (374 loc) · 77.7 KB
/
api.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
<!DOCTYPE HTML><html><head><title>API - Biblioteca Digital de Bogotá API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.1.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
// open modal on hashes like #_action_get
$(window).bind('hashchange', function(e) {
var anchor_id = document.location.hash.substr(1); //strip #
var element = $('#' + anchor_id);
// do we have such element + is it a modal? --> show it
if (element.length && element.hasClass('modal')) {
element.modal('show');
}
});
// execute hashchange on first page load
$(window).trigger('hashchange');
// remove url fragment on modal hide
$('.modal').on('hidden.bs.modal', function() {
try {
if (history && history.replaceState) {
history.replaceState({}, '', '#');
}
} catch(e) {}
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.badge_patch {
background-color: #ccc444;
}
.list-group, .panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h1 {
font-size: 1.3em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
padding-right: 5px;
overflow: auto;
height: 90%;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
margin: 0;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
pre code {
overflow: auto;
word-wrap: normal;
white-space: pre;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
</style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>API - Biblioteca Digital de Bogotá API documentation <small>version 1.0</small></h1><p></p><h3 id="introducci_n"><a href="#introducci_n">Introducción</a></h3><p>Esta es una breve introducción sobre los conceptos generales que se trabajan en el api, y algunas convenciones que se manejan en todas las peticiones.</p><h3 id="formato_de_datos"><a href="#formato_de_datos">Formato de datos</a></h3><p>Este api trabaja con respuestas JSON. Las descripciones de los objetos tienen todos los campos de los mismos, algunos de los cuales son de sólo lectura, pero no está especificado en cada elemento.</p><p>Los siguientes campos son siempre de sólo lectura:</p><ul><li>id</li><li>created_at</li><li>updated_at</li></ul><h3 id="asociaci_n_de_datos"><a href="#asociaci_n_de_datos">Asociación de datos</a></h3><p>Cuando un modelo tenga un campo que referencia a otro o a si mismo, este campo tendrá terminación <em>_id</em>. En algunos de los casos, las respuestas incluirán un campo adicional expandido, así:</p><pre><code class="lang-json">{
"id": 1,
"name": "I have an associated element",
"child_id": 2,
"child": {
"id": 2,
"name": "I have a parent."
}
}
</code></pre><p>Cuando un modelo tenga un campo que referencia a otros modelos, este campo tendrá terminació <em>_ids</em>. En algunos de los casos, las respuestas incluirán un campo adicional expandido, así:</p><pre><code class="lang-json">{
"id": 1,
"name": "I have associated models",
"model_ids": [2, 4],
"models": [
{
"id": 2,
"name": "I am a model object."
},
{
"id": 4,
"name": "I also a model object."
}
]
}
</code></pre><p>Los campos múltiples pueden venir paginados, en cuyo caso la expansión tendrá los campos de paginación, y los modelos asociados vendrán dentro de la propiedad <code>data</code>, tal cómo una colección paginada.</p><h3 id="colecciones"><a href="#colecciones">Colecciones</a></h3><p>Las peticiones que traigan colecciones de datos vendrán paginadas y tendrán la siguiente estructura:</p><pre><code class="lang-json">{
"current_page": 3,
"data": [
objeto,
objeto,
objeto,
...
objeto
],
"first_page_url": "https://api.bdb.gov.co/api/colors?page=1",
"from": 31,
"last_page": 5,
"last_page_url": "https://api.bdb.gov.co/api/colors?page=5",
"next_page_url": "https://api.bdb.gov.co/api/colors?page=4",
"path": "https://api.bdb.gov.co/api/colors",
"per_page": "15",
"prev_page_url": "https://api.bdb.gov.co/api/colors?page=2",
"to": 45,
"total": 70
}
</code></pre><p>Estas peticiones reciben dos parámetros por URL que controlan la página y la cantidad de objetos por página:</p><ul><li>page</li><li>items</li></ul><p>Ejemplo:</p><pre><code>?page=5&items25 # Trae la página 5, con 25 elementos en cada página.
</code></pre><h3 id="ordenamiento"><a href="#ordenamiento">Ordenamiento</a></h3><p>Algunas de las peticiones permiten ordenar los resultados por criterios enviados por URL. Cuando una petición es ordenable, se debe pasar un parámetro <code>orderby</code> en la url con los valores por los que se quiere ordenar separados por coma. Cuando un valor se quiere ordenar de forma descendente, se debe anteponer el signo <code>-</code> al mismo.</p><p>Cualquier petición que sea ordenable tiene los siguientes parámetros disponibles:</p><ul><li>updated_at</li><li>created_id</li><li>id</li></ul><p>Ejemplo:</p><pre><code>?orderby=id # Ordena por ID de forma ascendente
?orderby=-id # Ordena por ID de forma descendente
?orderby=updated_at,id #Ordena primero por fecha de actualización, y después por ID.
</code></pre><p>Algunas coleciones tendrán otras opciones de ordenamiento.</p><h3 id="filtrado"><a href="#filtrado">Filtrado</a></h3><p>En general, cualquier petición que sea ordenable, es filtrable. Existen 3 tipos de filtros:</p><ul><li>ContenidoEn Este filtro recibe una lista de valores separados por comas, y se devuelven los resultados que tengan cualquiera de estos. Por ejemplo productos que pertenecen a ciertas categorías.</li><li>Entre Este filtro recibe dos valores separados por comas y se devuelven los resultados que tengan valores contenidos entre estos dos, incluyendo los dos valores. Por ejemplo contenidos que están entre dos fechas.</li><li>Como Este filtro hace búsquedas de un patron de texto en una campo determinado, y devuelve los resultados que contengan dicho patrón. Acepta dos comodines. <code>%</code> para múltiples caracteres. <code>_</code> para un caracter.</li></ul><p>Los filtros se pasan por parametros de URL como arreglos de la siguiente forma: ``` ?filter[{{ filtro }}]={{ valor1,valor2 }}</p><p>Todos las colecciones ordenables tiene por defecto los siguientes elementos filtrables:</p><table class="table"><thead><tr><th>filtro</th><th>tipo</th></tr></thead><tbody><tr><td>id</td><td>ContenidoEn</td></tr><tr><td>updated_at</td><td>Entre</td></tr><tr><td>created_at</td><td>Entre</td></tr></tbody></table><p>Las colecciones que tengan campo <code>slug</code> aceptan el siguiente filtro:</p><table class="table"><thead><tr><th>filtro</th><th>tipo</th></tr></thead><tbody><tr><td>slug</td><td>Como</td></tr></tbody></table><h3 id="autenticaci_n"><a href="#autenticaci_n">Autenticación</a></h3><p>Existen 2 tipos de usuarios en el portal:</p><ul><li>Autenticado</li><li>No Autenticado</li></ul><p>Un usuario se considera autenticado cuando envía una petición con un token Bearer como encabezado:</p><pre><code>Authorization: Bearer TOKEN
</code></pre><p>Cada sesión de usuario tendrá un tóken diferente, de esta forma el usuario puede estar autenticado en multiples dispositivos a la vez.</p><p>Cuando un usuario cambia de contraseña, todos los tokens serán invalidados.</p><p>Para obtener el token, se debe hacer una petición a la ruta de logueo con las credenciales de el usuario. Si las credenciales son válidas el token es devuelto cómo parte del cuerpo del usuario validado. Ejemplo:</p><pre><code>{
"id": 8,
"api_token": "..."
...
}
</code></pre><p>Adicionalmente el token es enviado cuando un usuario:</p><ul><li>Se registra</li><li>Cambia su contraseña</li><li>Resetea su contraseña</li></ul><h3 id="errores_y_validaciones"><a href="#errores_y_validaciones">Errores y validaciones</a></h3><p>Cuando la petición no es exitosa por que la validación de datos no es correcta, las respuesta incluye información sobre que datos no pasaron la validación, incluyendo cada campo que no fue exitoso. Ejemplo:</p><pre><code>{
"message": "The given data was invalid.",
"errors": {
"email": [
"El campo email no corresponde con una dirección de e-mail válida."
],
"cover": [
"El campo cover debe ser una imagen."
]
}
}
</code></pre><p>Un caso especial es la validación de correo electrónico, que cuando ya existe uno registrado en el portal el error se envía en el campo "exists".</p><pre><code>{
"message": "The given data was invalid.",
"exists": [
"Hay otro usuario registrado con el mismo correo."
]
}
</code></pre><h3 id="permisos_y_autorizaciones"><a href="#permisos_y_autorizaciones">Permisos y autorizaciones</a></h3><p>Cada usuario podrá modificar los datos de los modelos de los que sea dueño. Los usuarios pueden tener roles asignados que les permiten efectuar operaciones adicionales en el portal.</p><p>Los dos roles iniciales son:</p><ul><li>admin: permite crear y modificar cualquier objeto en el portal, y cambiar el dueño de los objetos.</li><li>creator: permite crear contenidos.</li></ul></div><div class="panel panel-default"><div class="panel-heading"><h3 id="api_users" class="panel-title">/api/users</h3></div><div class="panel-body"><div class="top-resource-description"><p>Can not resolve users-description.md</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_users"><span class="parent"></span>/api/users</a> <span class="methods"><a href="#api_users_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#api_users_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_api_users" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_users_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get all the Users</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_users_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new User</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/api/users</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all the Users</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_get_request" data-toggle="tab">Request</a></li><li><a href="#api_users_get_response" data-toggle="tab">Response</a></li><li><a href="#api_users_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_get_request"><h3>Query Parameters</h3><ul><li><strong>email</strong>: <em>required (string)</em><p>Correo para revisar si existe. Con este parámetro la ruta es pública.</p></li><li><strong>q</strong>: <em>(string)</em><p>Criteros de búsqueda de los resultados.</p></li><li><strong>items</strong>: <em>(integer)</em><p>Número de items por página.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Número de página.</p></li><li><strong>orderby</strong>: <em>(string)</em><p>Criteros de ordenamiento de los resultados.</p></li><li><strong>filter</strong>: <em>(object)</em><p>Criteros de filtrado de los resultados.</p><ul><li><strong>//</strong>: <em>required (string)</em></li></ul></li></ul></div><div class="tab-pane" id="api_users_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>current_page</strong>: <em>required (integer)</em></li><li><strong>first_page_url</strong>: <em>required (string)</em></li><li><strong>from</strong>: <em>required (integer)</em></li><li><strong>last_page</strong>: <em>required (integer)</em></li><li><strong>last_page_url</strong>: <em>required (string)</em></li><li><strong>next_page_url</strong>: <em>required (string)</em></li><li><strong>path</strong>: <em>required (string)</em></li><li><strong>per_page</strong>: <em>required (integer)</em></li><li><strong>prev_page_url</strong>: <em>required (string)</em></li><li><strong>to</strong>: <em>required (integer)</em></li><li><strong>total</strong>: <em>required (integer)</em></li><li><strong>data</strong>: <em>required (array of User)</em><p><strong>Items</strong>: UserExpanded</p><div class="items"><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li></ul></div></li></ul></div><div class="tab-pane" id="api_users_get_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/api/users</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new User</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_post_request" data-toggle="tab">Request</a></li><li><a href="#api_users_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_post_request"><h3>Body</h3><p><strong>Media type</strong>: multipart/form-data</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>password</strong>: <em>(string)</em></li><li><strong>cover</strong>: <em>(file)</em></li><li><strong>picture</strong>: <em>(file)</em></li><li><strong>following_add</strong>: <em>(array of integer)</em></li><li><strong>following_remove</strong>: <em>(array of integer)</em></li><li><strong>favorites_add</strong>: <em>(array of integer)</em></li><li><strong>favorites_remove</strong>: <em>(array of integer)</em></li></ul><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>password</strong>: <em>(string)</em></li><li><strong>cover</strong>: <em>(file)</em></li><li><strong>picture</strong>: <em>(file)</em></li><li><strong>following_add</strong>: <em>(array of integer)</em></li><li><strong>following_remove</strong>: <em>(array of integer)</em></li><li><strong>favorites_add</strong>: <em>(array of integer)</em></li><li><strong>favorites_remove</strong>: <em>(array of integer)</em></li></ul></div><div class="tab-pane" id="api_users_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li><li><strong>api_token</strong>: <em>required (string)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_users__user_id_"><span class="parent">/api/users</span>/{user-id}</a> <span class="methods"><a href="#api_users__user_id__patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#api_users__user_id__get"><span class="badge badge_get">get</span></a> <a href="#api_users__user_id__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api_users__user_id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_users__user_id__patch'" class="list-group-item"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update the given User</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_users__user_id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the given User</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_users__user_id__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete the given User</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users__user_id__patch"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/users</span>/{user-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update the given User</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>owner</li></ul><p>Authentication by header</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users__user_id__patch_request" data-toggle="tab">Request</a></li><li><a href="#api_users__user_id__patch_response" data-toggle="tab">Response</a></li><li><a href="#api_users__user_id__patch_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users__user_id__patch_request"><h3>URI Parameters</h3><ul><li><strong>user-id</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>password</strong>: <em>(string)</em></li><li><strong>cover</strong>: <em>(file)</em></li><li><strong>picture</strong>: <em>(file)</em></li><li><strong>following_add</strong>: <em>(array of integer)</em></li><li><strong>following_remove</strong>: <em>(array of integer)</em></li><li><strong>favorites_add</strong>: <em>(array of integer)</em></li><li><strong>favorites_remove</strong>: <em>(array of integer)</em></li></ul></div><div class="tab-pane" id="api_users__user_id__patch_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_users__user_id__patch_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users__user_id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/api/users</span>/{user-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the given User</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users__user_id__get_request" data-toggle="tab">Request</a></li><li><a href="#api_users__user_id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users__user_id__get_request"><h3>URI Parameters</h3><ul><li><strong>user-id</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_users__user_id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users__user_id__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/users</span>/{user-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete the given User</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users__user_id__delete_request" data-toggle="tab">Request</a></li><li><a href="#api_users__user_id__delete_response" data-toggle="tab">Response</a></li><li><a href="#api_users__user_id__delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users__user_id__delete_request"><h3>URI Parameters</h3><ul><li><strong>user-id</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_users__user_id__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "Object deleted"
}</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_users__user_id__delete_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_users_login"><span class="parent">/api/users</span>/login</a> <span class="methods"><a href="#api_users_login_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_api_users_login" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_users_login_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Logs in an User</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_login_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/api/users</span>/login</h4></div><div class="modal-body"><div class="alert alert-info"><p>Logs in an User</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_login_post_request" data-toggle="tab">Request</a></li><li><a href="#api_users_login_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_login_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>required (string)</em></li><li><strong>password</strong>: <em>required (string)</em></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"email": "[email protected]",
"password": "asd|@123"
}</code></pre></div></div><div class="tab-pane" id="api_users_login_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li><li><strong>api_token</strong>: <em>required (string)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_users_password_recovery__email_"><span class="parent">/api/users</span>/password/recovery/{email}</a> <span class="methods"><a href="#api_users_password_recovery__email__get"><span class="badge badge_get">get</span></a> <a href="#api_users_password_recovery__email__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_api_users_password_recovery__email_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_users_password_recovery__email__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Requires a password recovery link for an user</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_users_password_recovery__email__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Validates a password reset token</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_password_recovery__email__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/api/users</span>/password/recovery/{email}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Requires a password recovery link for an user</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_password_recovery__email__get_request" data-toggle="tab">Request</a></li><li><a href="#api_users_password_recovery__email__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_password_recovery__email__get_request"><h3>URI Parameters</h3><ul><li><strong>email</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_users_password_recovery__email__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>A reset link has been send to the email specified</p><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "There was an error on the request",
"errors": {
"attempts": [
"Too many password request for the given email"
],
"email": [
"The given email is invalid or empty"
]
}
}</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_password_recovery__email__post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/api/users</span>/password/recovery/{email}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Validates a password reset token</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_password_recovery__email__post_request" data-toggle="tab">Request</a></li><li><a href="#api_users_password_recovery__email__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_password_recovery__email__post_request"><h3>URI Parameters</h3><ul><li><strong>email</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>token</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_users_password_recovery__email__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The provided password token is valid</p><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_users_password_reset__email_"><span class="parent">/api/users</span>/password/reset/{email}</a> <span class="methods"><a href="#api_users_password_reset__email__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_api_users_password_reset__email_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_users_password_reset__email__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Resets the password for the given user.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_users_password_reset__email__post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/api/users</span>/password/reset/{email}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Resets the password for the given user.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_users_password_reset__email__post_request" data-toggle="tab">Request</a></li><li><a href="#api_users_password_reset__email__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_users_password_reset__email__post_request"><h3>URI Parameters</h3><ul><li><strong>email</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>password</strong>: <em>required (string)</em></li><li><strong>token</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_users_password_reset__email__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Password changed succesfully.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>following_ids</strong>: <em>required (array of integer)</em></li><li><strong>id</strong>: <em>(integer)</em></li><li><strong>created_at</strong>: <em>(datetime)</em></li><li><strong>updated_at</strong>: <em>(datetime)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>first_name</strong>: <em>required (string)</em></li><li><strong>last_name</strong>: <em>required (string)</em></li><li><strong>about</strong>: <em>(string)</em></li><li><strong>phone</strong>: <em>(string)</em></li><li><strong>group_ids</strong>: <em>(array of integer)</em></li><li><strong>cover</strong>: <em>(string)</em></li><li><strong>picture</strong>: <em>(string)</em></li><li><strong>followers_id</strong>: <em>(array of integer)</em></li><li><strong>followers_ids</strong>: <em>required (array of integer)</em></li><li><strong>followers_count</strong>: <em>required (integer)</em></li><li><strong>following_count</strong>: <em>required (integer)</em></li><li><strong>api_token</strong>: <em>required (string)</em></li></ul><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="api_contents" class="panel-title">/api/contents</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_contents"><span class="parent"></span>/api/contents</a> <span class="methods"><a href="#api_contents_get"><span class="badge badge_get">get</span></a> <a href="#api_contents_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api_contents" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_contents_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all the Contents</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_contents_post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Create a new Content</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_contents_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/api/contents</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all the Contents</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_contents_get_request" data-toggle="tab">Request</a></li><li><a href="#api_contents_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_contents_get_request"><h3>Query Parameters</h3><ul><li><strong>q</strong>: <em>(string)</em><p>Criteros de búsqueda de los resultados.</p></li><li><strong>items</strong>: <em>(integer)</em><p>Número de items por página.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Número de página.</p></li><li><strong>orderby</strong>: <em>(string)</em><p>Criteros de ordenamiento de los resultados.</p></li><li><strong>filter</strong>: <em>(object)</em><p>Criteros de filtrado de los resultados.</p><ul><li><strong>//</strong>: <em>required (string)</em></li></ul></li></ul></div><div class="tab-pane" id="api_contents_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>current_page</strong>: <em>required (integer)</em></li><li><strong>first_page_url</strong>: <em>required (string)</em></li><li><strong>from</strong>: <em>required (integer)</em></li><li><strong>last_page</strong>: <em>required (integer)</em></li><li><strong>last_page_url</strong>: <em>required (string)</em></li><li><strong>next_page_url</strong>: <em>required (string)</em></li><li><strong>path</strong>: <em>required (string)</em></li><li><strong>per_page</strong>: <em>required (integer)</em></li><li><strong>prev_page_url</strong>: <em>required (string)</em></li><li><strong>to</strong>: <em>required (integer)</em></li><li><strong>total</strong>: <em>required (integer)</em></li><li><strong>data</strong>: <em>required (array of )</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_contents_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/api/contents</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new Content</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>owner</li></ul><p>Authentication by header</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_contents_post_request" data-toggle="tab">Request</a></li><li><a href="#api_contents_post_response" data-toggle="tab">Response</a></li><li><a href="#api_contents_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_contents_post_request"><h3>Body</h3><p><strong>Media type</strong>: multipart/form-data</p><p><strong>Type</strong>: ContentBase</p><strong>Properties</strong><ul><li><strong>images</strong>: <em>required (array of )</em></li><li><strong>images_remove</strong>: <em>(array of )</em></li></ul><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ContentBase</p><strong>Properties</strong><ul><li><strong>images</strong>: <em>required (array of )</em></li><li><strong>images_remove</strong>: <em>(array of )</em></li></ul></div><div class="tab-pane" id="api_contents_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ContentExpanded</p><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_contents_post_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_contents__content_id_"><span class="parent">/api/contents</span>/{content-id}</a> <span class="methods"><a href="#api_contents__content_id__patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#api_contents__content_id__get"><span class="badge badge_get">get</span></a> <a href="#api_contents__content_id__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api_contents__content_id_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_contents__content_id__patch'" class="list-group-item"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update the given Content</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_contents__content_id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the given Content</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_contents__content_id__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete the given Content</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_contents__content_id__patch"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/contents</span>/{content-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update the given Content</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>owner</li></ul><p>Authentication by header</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_contents__content_id__patch_request" data-toggle="tab">Request</a></li><li><a href="#api_contents__content_id__patch_response" data-toggle="tab">Response</a></li><li><a href="#api_contents__content_id__patch_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_contents__content_id__patch_request"><h3>URI Parameters</h3><ul><li><strong>content-id</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ContentBase</p><strong>Properties</strong><ul><li><strong>images</strong>: <em>required (array of )</em></li><li><strong>images_remove</strong>: <em>(array of )</em></li></ul></div><div class="tab-pane" id="api_contents__content_id__patch_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ContentExpanded</p><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_contents__content_id__patch_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_contents__content_id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/api/contents</span>/{content-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the given Content</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_contents__content_id__get_request" data-toggle="tab">Request</a></li><li><a href="#api_contents__content_id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_contents__content_id__get_request"><h3>URI Parameters</h3><ul><li><strong>content-id</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_contents__content_id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ContentExpanded</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_contents__content_id__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/contents</span>/{content-id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete the given Content</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_contents__content_id__delete_request" data-toggle="tab">Request</a></li><li><a href="#api_contents__content_id__delete_response" data-toggle="tab">Response</a></li><li><a href="#api_contents__content_id__delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_contents__content_id__delete_request"><h3>URI Parameters</h3><ul><li><strong>content-id</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_contents__content_id__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "Object deleted"
}</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_contents__content_id__delete_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="api_collections" class="panel-title">/api/collections</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_collections"><span class="parent"></span>/api/collections</a> <span class="methods"><a href="#api_collections_get"><span class="badge badge_get">get</span></a> <a href="#api_collections_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api_collections" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_collections_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all the Collections</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_collections_post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Create a new Collection</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_collections_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/api/collections</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all the Collections</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_collections_get_request" data-toggle="tab">Request</a></li><li><a href="#api_collections_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_collections_get_request"><h3>Query Parameters</h3><ul><li><strong>items</strong>: <em>(integer)</em><p>Número de items por página.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Número de página.</p></li><li><strong>orderby</strong>: <em>(string)</em><p>Criteros de ordenamiento de los resultados.</p></li><li><strong>filter</strong>: <em>(object)</em><p>Criteros de filtrado de los resultados.</p><ul><li><strong>//</strong>: <em>required (string)</em></li></ul></li></ul></div><div class="tab-pane" id="api_collections_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>current_page</strong>: <em>required (integer)</em></li><li><strong>first_page_url</strong>: <em>required (string)</em></li><li><strong>from</strong>: <em>required (integer)</em></li><li><strong>last_page</strong>: <em>required (integer)</em></li><li><strong>last_page_url</strong>: <em>required (string)</em></li><li><strong>next_page_url</strong>: <em>required (string)</em></li><li><strong>path</strong>: <em>required (string)</em></li><li><strong>per_page</strong>: <em>required (integer)</em></li><li><strong>prev_page_url</strong>: <em>required (string)</em></li><li><strong>to</strong>: <em>required (integer)</em></li><li><strong>total</strong>: <em>required (integer)</em></li><li><strong>data</strong>: <em>required (array of )</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_collections_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/api/collections</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new Collection</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_collections_post_request" data-toggle="tab">Request</a></li><li><a href="#api_collections_post_response" data-toggle="tab">Response</a></li><li><a href="#api_collections_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_collections_post_request"><h3>Body</h3><p><strong>Media type</strong>: multipart/form-data</p><p><strong>Type</strong>: CollectionRequest</p><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: CollectionRequest</p></div><div class="tab-pane" id="api_collections_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: CollectionExpanded</p><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_collections_post_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_api_collections__collection_slug_"><span class="parent">/api/collections</span>/{collection-slug}</a> <span class="methods"><a href="#api_collections__collection_slug__get"><span class="badge badge_get">get</span></a> <a href="#api_collections__collection_slug__patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#api_collections__collection_slug__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api_collections__collection_slug_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_collections__collection_slug__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the given Collection</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_collections__collection_slug__patch'" class="list-group-item"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update the given Collection</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_collections__collection_slug__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete the given Collection</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_collections__collection_slug__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/api/collections</span>/{collection-slug}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the given Collection</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_collections__collection_slug__get_request" data-toggle="tab">Request</a></li><li><a href="#api_collections__collection_slug__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_collections__collection_slug__get_request"><h3>URI Parameters</h3><ul><li><strong>collection-slug</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_collections__collection_slug__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: CollectionExpanded</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_collections__collection_slug__patch"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/collections</span>/{collection-slug}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update the given Collection</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_collections__collection_slug__patch_request" data-toggle="tab">Request</a></li><li><a href="#api_collections__collection_slug__patch_response" data-toggle="tab">Response</a></li><li><a href="#api_collections__collection_slug__patch_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_collections__collection_slug__patch_request"><h3>URI Parameters</h3><ul><li><strong>collection-slug</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: CollectionRequest</p></div><div class="tab-pane" id="api_collections__collection_slug__patch_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: CollectionExpanded</p><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_collections__collection_slug__patch_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_collections__collection_slug__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/api/collections</span>/{collection-slug}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete the given Collection</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>token</b> with scopes:<ul><li>admin</li></ul><p>Authentication by header</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_collections__collection_slug__delete_request" data-toggle="tab">Request</a></li><li><a href="#api_collections__collection_slug__delete_response" data-toggle="tab">Response</a></li><li><a href="#api_collections__collection_slug__delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_collections__collection_slug__delete_request"><h3>URI Parameters</h3><ul><li><strong>collection-slug</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="api_collections__collection_slug__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "Object deleted"
}</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/4XX" target="_blank">4XX</a></h2><p>Invalid request.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>message</strong>: <em>required (string)</em></li><li><strong>errors</strong>: <em>(object)</em><ul><li><strong>/^[a-z_]*$/</strong>: <em>required (array of string)</em></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"message": "The given data was invalid.",
"errors": {
"field_name_1": [
"Invalid data provided for field_name_1."
],
"field_name_2": [
"field_name_2 is required."
]
}
}</code></pre></div></div><div class="tab-pane" id="api_collections__collection_slug__delete_securedby"><h1>Secured by token</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Use the Bearer keyword. Example Authorization Bearer [API_key]</p></li></ul></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#api_users">/api/users</a></li><li><a href="#api_contents">/api/contents</a></li><li><a href="#api_collections">/api/collections</a></li></ul></div></div></div></div></body></html>