udistrital / argo_documentacion

0 stars 0 forks source link

Implementación microservicio Sicapital MID #62

Closed edwargl7 closed 4 months ago

edwargl7 commented 4 months ago

Se requiere realizar la implementación del microservicio MID Sicapital para ARGO v2 basado en los endpoints validados en la Issue #52 que permita la comunicación de los datos requeridos de Sicapital a ARGO. La creación de este MID se genera con el fin de desacoplar el core de la nueva versión de ARGO con la fuente de datos de sicapital manteniendo una interfaz que permita a este microservicio mantener la estructura de datos hacía el CORE y encargándose de gestionar la lógica necesaria y consumo de endpoints requeridos para recopilar dicha información.

Especificaciones técnicas

  1. Repositorio de este nuevo microservicio presupuesto_contractual_mid.
  2. El API debe cumplir con los siguientes lineamientos:

    a. Lineamiento y Metodología para Branches b. Etiquetas en comentarios de Commits c. Definición de endpoints para APIs REST Hoja resumen de buenas prácticas y Aclaración y ejemplos de nombres adecuados para endpoints image

  3. Guiarse en la construcción del microservicio basado en los lineamientos de APIS Beego si se usa Golang.

Sub Tareas

Criterios de aceptación

Requerimientos

No aplica

Definition of Ready - DoR

Definition of Done - DoD - Desarrollo

edwargl7 commented 4 months ago

Se crea el endpoint de consulta de información del CPD basado en Script con información sobre proveedores en el ARGO actual. Confirmar si se requieren más campos adicionales a los abordados en dicha consulta, por favor.

mau-oati commented 4 months ago

Se inicia el proceso de desarrollo local, probando librerías de conversión de XML a JS, al final se usó xml2js, se iniciaron pruebas de modelado con el endpoint nuevo.

mau-oati commented 4 months ago

Se revisa la necesidad de un endpoint que retorne la cantidad de numeros de disponibilidad para completar el flujo que existirá mas adelante en el frontend, dicho endpoint filtrado por vigencia y unidad_ejecutora.

mau-oati commented 4 months ago

Se encuentra que el endpoint nuevo retorna una lista de CDPs todos iguales, pero se esperaría que debería llegar solo 1.

mau-oati commented 4 months ago

Se ajusta para retornar el primer CDP, se evalúa la posibilidad de agregar un filtro adicional de facultad para asegurar el retorno del CDP adecuado, se prueba en local el retorno unitario.

edwargl7 commented 4 months ago

Se realiza la revisión del desarrollo realizado, se puede usar de guía el proyecto espacios_academicos_crud. Además, se observa el uso del HOST directamente en el service y no como variable de entorno. Se debe realizar el ajuste. Documentar las pruebas del funcionamiento del endpoint desarrollado.

Cuenta con la documentación el repositorio. Buen trabajo. Se debe completar los ajustes y pruebas.

mau-oati commented 4 months ago

Ejemplo Request

/cdp?vigencia=2024&numeroDisponibilidad=2314&unidadEjecutora=01

Ejemplo de Response del API MID

[
  {
    "vigencia": "2024",
    "descripcion": "Cesantías",
    "rubro_interno": "123",
    "estado": "APROBADA",
    "justificacion": "LA FACULTAD ABCDEF",
    "id_sol_cdp": "123",
    "nombre_dependencia": "FACULTAD DEL DERECHO",
    "fecha_registro": "2024-02-05T00:00:00.000+00:00",
    "observaciones": "SUELDO BÁSICO",
    "numero_disponibilidad": "1234",
    "num_sol_adq": "1234",
    "valor_contratacion": "123",
    "estadocdp": "VIGENTE"
  }
]
mau-oati commented 4 months ago

Se hizo el ajuste del host y response para completar la tarea.

edwargl7 commented 4 months ago

Se realiza la revisión y cumple con el ajuste pendiente, se trabajará al finalizar el sprint la revisión del desarrollo en una sesión para complementar las pruebas y evitar exponer en la prueba datos de los CDP. Se trabajará en la Issue #73 el ajuste de primer letra mayúscula en la respuesta del endpoint.