Commit b7f63edd authored by Gustavo Callejas Espinoza's avatar Gustavo Callejas Espinoza
Browse files

Se corrigio y modifico la documentación de autenticación y de las entidades...

Se corrigio y modifico la documentación de autenticación y de las entidades cargo, comentario, datoPostulante, postulacion, postulantes, tag, tagPostulante y tipoDato
parent 9f93e637
......@@ -5,12 +5,12 @@ ___
**URL**
>/autenticar/ldap
**Metodo**
**Método**
><kbd>POST</kbd>
**Parametros de la URL**
**Parámetros de la URL**
**Parametros del body**
**Parámetros del body**
```json
{
"nombreUsuario": "test",
......
......@@ -4,14 +4,14 @@ ___
**URL**
> /cargos
**Metodo**
**Método**
> <kbd>GET</kbd>
**Respuesta correcta**
>**Codigo:** 200
>**Código:** 200
>**Ejemplo:**
>**Contenido:**
```json
{
"count":5,"rows":
......@@ -50,9 +50,9 @@ ___
}
```
**Parametros opcionales de la URL**
**Parámetros opcionales de la URL**
>**Muestra una determinada cantidad de cargos**
>**URL**
```
/cargos?elementos=valor
......@@ -87,13 +87,14 @@ valor=[integer]
```
>___
>**Muestra los cargos en una determinada página**
>**URL**
```
/cargos?pagina=valor
```
>**Parámetros requeridos**
```
pagina=[integer]
valor=[integer]
```
>**Ejemplo:**
```
......@@ -139,14 +140,15 @@ pagina=[integer]
}
```
>___
>**Ordena los cargos en base a un atributo**
>**Ordena los cargos ascendentemente en base a un campo del modelo**
>**URL**
```
/cargos?ordenarPor=valor
```
>**Parámetros requeridos**
```
ordenarPor=[string]
valor=[string]
```
>**Ejemplo:**
```
......@@ -191,15 +193,15 @@ ordenarPor=[string]
}
```
>___
>**Ordena los cargos ascendentemente o descendentemente en base a un atributo**
>**Ordena los cargos descendentemente en base a un campo del modelo**
>**URL**
```
/cargos?ordenarPor=valor1&orden=valor2
/cargos?ordenarPor=valor1&orden=DESC
```
>**Parámetros requeridos**
```
valor1=[string]
valor2=[string] (DESC)
```
>**Ejemplo:**
```
......@@ -244,7 +246,7 @@ valor2=[string] (DESC)
}
```
>___
>**Busca los cargos que en sus nombre contenga la palabra "Secretario"**
>**Busca los cargos que contenga el nombre de "Secretario"**
>**URL**
```
......@@ -266,7 +268,7 @@ valor2=[string] (DESC)
}
```
>___
>**Busca los postulantes para el cargo "Secretario", las postulaciones estan ordenadas por presentacion de forma ascendente**
>**Busca los postulantes para el cargo "Secretario"**
>**URL**
```
......@@ -290,7 +292,6 @@ valor2=[string] (DESC)
"nombres": "Victor Hugo",
"apellidos": "Daza Lima",
"ci": 372348,
"sexo": true,
"fecha_creacion": "2016-01-14T22:52:31.554Z",
"fecha_modificacion": "2016-01-14T22:52:31.554Z",
"Postulacion":
......@@ -308,7 +309,6 @@ valor2=[string] (DESC)
"nombres": "Franz Ramiro",
"apellidos": "Gallardo Portanda",
"ci": 878789,
"sexo": true,
"fecha_creacion": "2016-01-14T22:52:31.554Z",
"fecha_modificacion": "2016-01-14T22:52:31.554Z",
"Postulacion":
......@@ -329,7 +329,7 @@ valor2=[string] (DESC)
**Respuesta de error**
>**Codigo:** 500
>**Código:** 500
>**Contenido:**
```json
......@@ -341,32 +341,32 @@ valor2=[string] (DESC)
**Observaciones**
>Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
>El parametro 'orden' depende de 'ordenarPor'
>El parámetro 'orden' depende de 'ordenarPor'
>El parametro 'pagina' muestra 15 cargos por defecto
>El parámetro 'pagina' muestra 15 cargos por defecto
___
## Crear un nuevo cargo
## Crear un cargo
___
**URL**
> /cargos
**Metodo**
**Método**
> <kbd>POST</kbd>
**Parametros del body**
>**Ejemplo**
**Parámetros del body**
>**Ejemplo:**
```json
{
"nombre":"Jefe de unidad"
"nombre":"Jefe"
}
```
**Respuesta correcta**
>**Codigo:** 201
>**Código:** 201
>**Ejemplo:**
>**Contenido:**
```json
{
"_id": 81,
......@@ -378,8 +378,7 @@ ___
**Respuesta de error**
>**Codigo:** 400
>**Código:** 400
>**Contenido:**
```json
......@@ -399,61 +398,62 @@ ___
```
___
## Editar un cargo
## Mostrar un cargo
___
**URL**
> /cargos/:id
**Metodo**
> <kbd>PUT</kbd>
**Método**
> <kbd>GET</kbd>
**Parámetros de la URL**
**Parametros de la url**
>**Parametro requerido:**
>**Parámetro requerido:**
```
id=[integer]
```
>**Ejemplo:**
```
id=83
```
**Parametros del body**
>ejemplo
```json
{
"nombre":"Jefe de unidad"
}
id=49
```
**Respuesta correcta**
>**Codigo:** 200
>**Ejemplo**
>**Código:** 200
>**Ejemplo:**
```json
{
"_id": 83,
"nombre": "Jefe modificado",
"fecha_creacion": "2016-03-15T22:28:25.816Z",
"fecha_modificacion": "2016-03-15T22:29:50.184Z"
"_id": 49,
"nombre": "Secretario",
"fecha_creacion": "2016-03-14T22:52:31.554Z",
"fecha_modificacion": "2016-03-14T22:52:31.554Z"
}
```
**Respuesta de error**
>**Codigo:** 404
>**Código:** 404
>**Contenido:**
```json
{
"message": "Entidad no encontrada"
}
```
___
## Eliminar un cargo
## Editar un cargo
___
**URL**
> /cargos/:id
**Metodo**
**Método**
> <kbd>PUT</kbd>
**Parametros de la url**
>**Parametro requerido:**
**Parámetros de la URL**
>**Parámetro requerido:**
```
id=[integer]
```
......@@ -462,13 +462,31 @@ id=[integer]
id=83
```
**Parámetros del body**
>**Ejemplo:**
```json
{
"nombre":"Jefe modificado"
}
```
**Respuesta correcta**
>**Codigo:** 204
>**Código:** 200
>**Contenido:**
```json
{
"_id": 83,
"nombre": "Jefe modificado",
"fecha_creacion": "2016-03-15T22:28:25.816Z",
"fecha_modificacion": "2016-03-15T22:29:50.184Z"
}
```
**Respuesta de error**
>**Codigo:** 404
>**Código:** 404
>**Contenido:**
```json
......@@ -477,7 +495,7 @@ id=83
}
```
>**Codigo:** 400
>**Código:** 400
>**Contenido:**
```json
......@@ -502,11 +520,12 @@ ___
**URL**
> /cargos/:id
**Metodo**
**Método**
> <kbd>PUT</kbd>
**Parametros de la url**
>**Parametro requerido:**
**Parámetros de la URL**
>**Parámetro requerido:**
```
id=[integer]
```
......@@ -517,11 +536,11 @@ id=83
**Respuesta correcta**
>**Codigo:** 204
>**Código:** 204
**Respuesta de error**
>**Codigo:** 404
>**Código:** 404
>**Contenido:**
```json
......
___
## Obtener todos los comentarios
## Mostrar todos los comentarios
___
**URL**
> /comentarios
**Metodo**
**Método**
> <kbd>GET</kbd>
**Respuesta correcta**
>**Codigo:** 200
>**Código:** 200
>**Ejemplo:**
```json
......@@ -41,8 +41,9 @@ ___
}
```
**Parametros opcionales de la URL**
**Parámetros opcionales de la URL**
>**Muestra una determinada cantidad de comentarios**
>**URL**
```
/comentarios?elementos=valor
......@@ -79,13 +80,14 @@ valor=[integer]
```
>___
>**Muestra los comentarios en una determinada página**
>**URL**
```
/comentarios?pagina=valor
```
>**Parámetros requeridos**
```
pagina=[integer]
valor=[integer]
```
>**Ejemplo:**
```
......@@ -121,14 +123,15 @@ pagina=[integer]
}
```
>___
>**Ordena los comentarios en base a un atributo**
>**Ordena los comentarios ascendentemente en base a un campo del modelo**
>**URL**
```
/comentarios?ordenarPor=valor
```
>**Parámetros requeridos**
```
ordenarPor=[string]
valor=[string]
```
>**Ejemplo:**
```
......@@ -164,15 +167,15 @@ ordenarPor=[string]
}
```
>___
>**Ordena los comentarios ascendentemente o descendentemente en base a un atributo**
>**Ordena los comentarios descendentemente en base a un campo del modelo**
>**URL**
```
/comentarios?ordenarPor=valor1&orden=valor2
/comentarios?ordenarPor=valor1&orden=DESC
```
>**Parámetros requeridos**
```
valor1=[string]
valor2=[string] (DESC)
```
>**Ejemplo:**
```
......@@ -208,7 +211,7 @@ valor2=[string] (DESC)
}
```
>___
>**Busca los comentarios que contiene la palabra "postergo" en el atributo "contenido"**
>**Busca los comentarios que contenga la palabra "postergo" en el campo "contenido"**
>**URL**
```
......@@ -255,7 +258,6 @@ valor2=[string] (DESC)
"nombres": "Hugo Juan",
"apellidos": "Layme Pereida",
"ci": 372348,
"sexo": true,
"fecha_creacion": "2016-01-14T22:52:31.554Z",
"fecha_modificacion": "2016-01-14T22:52:31.554Z"
}
......@@ -272,7 +274,6 @@ valor2=[string] (DESC)
"nombres": "Hugo Juan",
"apellidos": "Layme Pereida",
"ci": 372348,
"sexo": true,
"fecha_creacion": "2016-01-14T22:52:31.554Z",
"fecha_modificacion": "2016-01-14T22:52:31.554Z"
}
......@@ -289,7 +290,6 @@ valor2=[string] (DESC)
"nombres": "Juan Pablo",
"apellidos": "Oropeza Velez",
"ci": 233232,
"sexo": true,
"fecha_creacion": "2016-01-14T22:52:31.554Z",
"fecha_modificacion": "2016-01-14T22:52:31.554Z"
}
......@@ -301,7 +301,7 @@ valor2=[string] (DESC)
**Respuesta de error**
>**Codigo:** 500
>**Código:** 500
>**Contenido:**
```json
......@@ -313,11 +313,9 @@ valor2=[string] (DESC)
**Observaciones**
>Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
>El parametro 'orden' depende de 'ordenarPor'
>El parametro 'pagina' muestra 15 comentarios por defecto
>El parámetro 'orden' depende de 'ordenarPor'
>El parámetro 'pagina' muestra 15 comentarios por defecto
___
## Crear un comentario
......@@ -325,11 +323,11 @@ ___
**URL**
> /comentarios
**Metodo**
**Método**
> <kbd>POST</kbd>
**Parametros del body**
>**Ejemplo**
**Parámetros del body**
>**Ejemplo:**
```json
{
"contenido": "comentario de prueba",
......@@ -339,9 +337,9 @@ ___
**Respuesta correcta**
>**Codigo:** 201
>**Código:** 201
>**Ejemplo:**
>**Contenido:**
```json
{
"_id": 189,
......@@ -354,8 +352,7 @@ ___
**Respuesta de error**
>**Codigo:** 400
>**Código:** 400
>**Contenido:**
```json
......@@ -374,17 +371,64 @@ ___
}
```
___
## Mostrar un comentario
___
**URL**
> /cargos/:id
**Método**
> <kbd>GET</kbd>
**Parámetros de la URL**
>**Parámetro requerido:**
```
id=[integer]
```
>**Ejemplo:**
```
id=49
```
**Respuesta correcta**
>**Código:** 200
>**Ejemplo:**
```json
{
"_id": 180,
"contenido": "¿Por qué se postergo el examen?",
"fecha_creacion": "2016-03-16T15:40:22.267Z",
"fecha_modificacion": "2016-03-16T15:40:22.267Z",
"fk_postulante": 242
}
```
**Respuesta de error**
>**Código:** 404
>**Contenido:**
```json
{
"message": "Entidad no encontrada"
}
```
___
## Editar un comentario
___
**URL**
> /comentarios/:id
**Metodo**
**Método**
> <kbd>PUT</kbd>
**Parametros de la url**
>**Parametro requerido:**
**Parámetros de la URL**
>**Parámetro requerido:**
```
id=[integer]
```
......@@ -393,22 +437,23 @@ id=[integer]
id=83
```
**Parametros del body**
>ejemplo
**Parámetros del body**
>**Ejemplo:**
```json
{
"contenido": "Comentario modificado",
"fk_postulante":241
"fk_postulante": 241
}
```
**Respuesta correcta**
>**Codigo:** 200
>**Ejemplo**
>**Código:** 200
>**Contenido:**
```json
{
"_id": 178,
"_id": 83,
"contenido": "Comentario modificado",
"fecha_creacion": "2016-03-16T15:40:22.265Z",
"fecha_modificacion": "2016-03-16T15:48:49.656Z",
......@@ -416,10 +461,9 @@ id=83
}
```
**Respuesta de error**
>**Codigo:** 404
>**Código:** 404
>**Contenido:**
```json
......@@ -428,7 +472,7 @@ id=83
}
```
>**Codigo:** 400
>**Código:** 400
>**Contenido:**
```json
......@@ -453,11 +497,12 @@ ___
**URL**
> /comentarios/:id
**Metodo**
**Método**
> <kbd>DELETE</kbd>
**Parametros de la url**
>**Parametro requerido:**
**Parámetros de la URL**
>**Parámetro requerido:**
```
id=[integer]
```
......@@ -468,11 +513,11 @@ id=83
**Respuesta correcta**
>**Codigo:** 204
>**Código:** 204
**Respuesta de error**
>**Codigo:** 404