Commit 492798cb authored by Grover Pinto's avatar Grover Pinto

Correccion de algunas rutas apidoc, adicion de nuevos apidoc para catalogos

parent e128fb7d
......@@ -17,6 +17,49 @@ module.exports = app => {
else next();
}
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Crear catalogo
@api {post} /api/v1/plantillasFormly/catalogo/ Crear catalogo
@apiDescription Crear catalogo
@apiParam (Petición) {Texto} nombre Nombre asignado al catalogo
@apiParam (Petición) {Texto} descipcion Descipción del catalogo a crear
@apiParam (Petición) {Array} documentos Lista de documentos que serán parte del catalogo
@apiParam (Petición) {Array} usuarios Lista de usuarios que podrán visualizar el catalogo
@apiParamExample {json} Ejemplo para enviar:
{
"nombre":"Mi primer Catalogo",
"descripcion": "La descripcion de mi catalogo",
"documentos":[{
"descripcion": "Este documento inicio el proyecto",
"estado": "ACTIVO",
id_documento: 12345,
nombre: "ENTIDAD/NI/0001/2020"
},...],
"usuarios":[
{
"nombres":"Juan",
"apellidos":"Perez Flores",
"estado":"ACTIVO",
"id_usuario": 35
},...
]
}
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "Creacion exitosa",
"datos": {
id_catalogo: 1
}
}
@apiSampleRequest off
*/
app.post('/api/v1/plantillasFormly/catalogo', (req, res) => {
req.body._usuario_creacion= req.body.audit_usuario.id_usuario;
const datosCatalogo = JSON.parse(JSON.stringify(req.body));
......@@ -64,7 +107,54 @@ module.exports = app => {
});
});
});
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Modificar catalogo
@api {post} /api/v1/plantillasFormly/catalogo/:id Modificar catalogo
@apiDescription Modificar catalogo
@apiParam (Params) {Number} id Identificador del catalogo a modificar
@apiParam (Petición) {Texto} nombre Nombre asignado al catalogo
@apiParam (Petición) {Texto} descipcion Descipción del catalogo a crear
@apiParam (Petición) {Array} documentos Lista de documentos que serán parte del catalogo
@apiParam (Petición) {Array} usuarios Lista de usuarios que podrán visualizar el catalogo
@apiParamExample {json} Ejemplo para enviar:
{
"id_catalogo": 1,
"nombre":"Mi primer Catalogo MODIFICADO",
"descripcion": "La descripcion de mi catalogo",
"documentos":[{
"descripcion": "Este documento inicio el proyecto",
"estado": "ACTIVO",
id_documento: 12345,
nombre: "ENTIDAD/NI/0001/2020",
"id_catalogo_documento": 1,
"fid_catalogo": 1
},...],
"usuarios":[
{
"nombres":"Juan",
"apellidos":"Perez Flores",
"estado":"ACTIVO",
"id_usuario": 35,
"id_catalogo_usuario": 1,
"lectura": false,
"fid_catalogo": 1
},...
]
}
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "Actualización exitosa"
}
@apiSampleRequest off
*/
app.put('/api/v1/plantillasFormly/catalogo/:id', (req, res) => {
const catalogo = JSON.parse(JSON.stringify(req.body));
const documentos = catalogo.documentos;
......@@ -95,6 +185,51 @@ module.exports = app => {
});
});
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Obtener catalogo
@api {get} /api/v1/plantillasFormly/catalogo/:id Obtener catalogo especifico
@apiDescription Obtener un catalogo especifico
@apiParam (Params) {Number} id Identificador del catalogo a obtener
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "Obtención de catalogo exitosa",
"datos": {
"id_catalogo": 1,
"nombre": "Mi primer Catalogo",
"descripcion": "La descripcion de mi catalogo",
"estado": "ACTIVO",
"_usuario_creacion": 100,
"documentos": [{
}],
"usuarios": [{
"id_catalogo_usuario": 1,
"fid_catalogo": 1,
"fid_usuario": 1,
"lectura": true,
"escritura": false,
"eliminar": false,
"estado": "ACTIVO",
"_usuario_creacion": 100,
"_usuario_modificacion": null,
"_fecha_creacion": "2020-03-16T14:02:48.862Z",
"_fecha_modificacion": "2020-03-16T14:02:48.862Z",
"nombres": "Juan",
"apellidos": "Perez Flores",
"cargo": "Desarrollo de Aplicaciones"
}]
}
}
@apiSampleRequest off
*/
app.get('/api/v1/plantillasFormly/catalogo/:id', (req, res) => {
const datosResp = {
documentos: [],
......@@ -162,6 +297,40 @@ module.exports = app => {
.catch(error => res.status(412).send(util.formatearMensaje('ERROR', error)));
});
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Obtener mis catalogos
@api {get} /api/v1/plantillasFormly/catalogo/:id/miscatalogos?order=-_fecha_modificacion&limit=10&page=1&filter=&fields=id_catalogo,nombre,descripcion,estado Obtiene la lista de catalogos del usuario
@apiDescription Obtener mis catalogos
@apiParam (Params) {Number} id Identificador del usuario para el cual obtener la lista de catalogos
@apiParam (Params) {Texto} order Campo por el cual se realiza un ordenamiento del resultado
@apiParam (Params) {Number} limit Numero de resultados máximo
@apiParam (Params) {Number} page Página de resultados
@apiParam (Params) {Texto} fields Campos necesarios que se incluiran en el resultado
@apiParam (Params) {Texto} filter Campo por el cual se realiza un filtrado de los resultados
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "Obtención de catalogos exitosa",
"datos": {
"total": 1,
"resultado": [{
"id_catalogo": 1,
"nombre": "Mi catalogo",
"descripcion": "La descripcion de mi catalogo",
"estado": "ACTIVO",
"_usuario_creacion": 100,
}]
}
}
@apiSampleRequest off
*/
app.get('/api/v1/plantillasFormly/catalogo/:id/miscatalogos', filtros, (req,res) => {
const opcionesCatalogo = {
where: {
......@@ -183,6 +352,40 @@ module.exports = app => {
.catch(error => res.status(412).send(util.formatearMensaje('ERROR', error)));
});
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@api {get} /api/v1/plantillasFormly/catalogo/:id/compartidos?order=-_fecha_modificacion&limit=10&page=1&filter=&fields=id_catalogo,nombre,descripcion,estado Obtiene la lista de catalogos compartidos con un usuario
@apiName Obtener catalogos compartidos
@apiDescription Obtener catalogos compartidos
@apiParam (Params) {Number} id Identificador del usuario para el cual obtener la lista de catalogos compartidos
@apiParam (Params) {Texto} order Campo por el cual se realiza un ordenamiento del resultado
@apiParam (Params) {Number} limit Numero de resultados máximo
@apiParam (Params) {Number} page Página de resultados
@apiParam (Params) {Texto} fields Campos necesarios que se incluiran en el resultado
@apiParam (Params) {Texto} filter Campo por el cual se realiza un filtrado de los resultados
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "Obtención de catalogos exitosa",
"datos": {
"total": 1,
"resultado": [{
"id_catalogo": 1,
"nombre": "Mi catalogo",
"descripcion": "La descripcion de mi catalogo",
"estado": "ACTIVO",
"_usuario_creacion": 100,
}]
}
}
@apiSampleRequest off
*/
app.get('/api/v1/plantillasFormly/catalogo/:id/compartidos', filtros, (req,res) => {
const opcionesCatUsuario = {
where: {
......@@ -223,7 +426,7 @@ module.exports = app => {
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Delete catalogo
@api {delete} /api/v1/plantillasFormly/catalogo/:id/miscatalogos Borrrar catalogo
@api {delete} /api/v1/plantillasFormly/catalogo/:id/miscatalogos Borrar catalogo
@apiDescription Eliminar catalogo
......
......@@ -8,6 +8,33 @@ module.exports = app => {
const bl = require('../../bl/plantillasFormly/catalogoBL');
/**
@apiVersion 2.0.0
@apiGroup Catalogo
@apiName Modificar documento en catalogo
@api {put} /api/v1/plantillasFormly/catalogo/documento/:id Modifica documento en catalogo
@apiDescription Modificar documento en catalogo
@apiParam (Params) {Number} id Identificador de la relacion catalogo-documento a modificar
@apiParam (Petición) {Number} fid_catalogo Identificador del catalogo
@apiParam (Params) {Object} actualizar Conjunto de datos a actualizar
@apiParamExample {json} Ejemplo para enviar:
{
"fid_catalogo": 1,
"actualizar": {
"estado": "INACTIVAR"
}
}
@apiSuccessExample {json} Respuesta del Ejemplo:
HTTP/1.1 200 OK
{
"tipoMensaje": "EXITO",
"mensaje": "modificación exitosa"
}
@apiSampleRequest off
*/
app.put('/api/v1/plantillasFormly/catalogo/documento/:id', (req, res) => {
return CatalogoDocumento.findOne({
where: {
......@@ -27,8 +54,8 @@ module.exports = app => {
//------------------> BUSCAR POR CATALOGOS
/**
@apiVersion 2.0.0
@apiGroup Documento
@apiName Post documento
@apiGroup Catalogo
@apiName Post catalogo
@api {post} /api/v1/plantillasFormly/catalogo/documento?limit=10&page=2 Buscar catalogo
@apiDescription Post para buscar catalogos
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment