Pipeline de industrialización

¿Cual es el horario de operación del pipeline de industrialización? arrow2-down

En el momento el Pipeline se puede usar 7x24, pero el soporte se da de lunes a viernes de 8:00AM a 5:00PM.

¿Qué debo hacer si ya tengo un archivo SecurityE2E en mi repositorio? arrow2-down

Al momento de ejecutar el pipeline se debe desmarcar la creación de este archivo ya que de lo contrario generara error porque el pipeline no puede sobrescribirlo.

¿Cuál es el formato de fecha que valida el pipeline? arrow2-down

El pipeline valida la estructura del campo Date-time según la norma ISO 8601.

¿El pipeline de industrialización valida los ejemplos del contrato API? arrow2-down

Si, se valida que los ejemplos que se encuentran en el contrato del API, correspondan con el tipo de dato y el formato definido.

¿Qué artefactos se crean a partir de la ejecución del pipeline? arrow2-down
  • El contrato del producto API.
  • El artefacto de pruebas de la API.
  • La configuración necesaria para el funcionamiento del mock de la API en Microcks.
  • La configuración del engine de seguridad.
  • Se adiciona la lógica de manejo de excepciones de tipo 400 al assembly de la API.
 
¿Cuál es el objetivo de la industrialización? arrow2-down

El objetivo principal de la industrialización, es facilitarle a los equipos productores la construcción de las APIs en las diferentes etapas de su cicIo de vida, entregando insumos con mejor calidad y reduciendo el tiempo de creación de los mismos.

¿Cómo documentar los enum de un campo? arrow2-down

El código de los dominios de valores fijos o enum se asigna de acuerdo a la guía modelo canónico y en su descripción se especifica a qué hace referencia dicho código. Por ejemplo:

Código - Descripción
"EMP" - Empleado
 
Si tienes dudas sobre qué es un enum o necesitas conocer más sobre su documentación, te invitamos a consultar la guía OpenAPI 3.0.
¿Qué .feature debo compartirle al desarrolladores? arrow2-down

Al equipo de desarrollo, se sugiere compartirles la rama donde ejecutamos la generación del pipeline para que tomen lo que puedan necesitar. Ejemplo, los .feature que se llaman "contractTest" es lo que aprovechan los desarrolladores para agilizar las pruebas.

Sin embargo, ten presente que en el repo "Template_ServiciosIntegracionAPIs_Documentacion" los insumos que se suben son el contrato de la(s) API y las acceptanceTest.feature.

Error MUST SET FRAME en la ejecución del pipeline arrow2-down

Revisa que no le hayas cambiado el formato al archivo, específicamente que las celdas del DO estén con todos los bordes.

Error The filed: [fieldName] in the minimum length o maximum length arrow2-down

Cuando este mensaje está asociado a la longitud máxima o mínima de un campo, significa que hay un campo en el DO que tiene filas compartidas; por allí debes buscar la corrección.

Error en pipeline Cannot resolve reference: #/... arrow2-down

Este error se muestra en el stage de API Contract relacionado con esta descripción "409nombreFuncionalOperación", soluciónalo borrando los caracteres como espacios, tabs o saltos de línea al inicio o final del nombre funcional.

¿Por qué el pipeline no me genera la carpeta con el nombre de la capacidad? arrow2-down

Si no te genera la carpeta, tampoco te va a generar los .feature ni el ejemplo. Esto ocurre cuando se tiene un nombre cuya longitud supera el límite definido en Windows/GIT, por lo que te invitamos a seguir las Instrucciones ajustar límite longitudes directorios.

¿Debo subir al repositorio de documentación de APIs (Template), los insumos del repositorio del NU/AW? arrow2-down

Si, es necesario montar el contrato beta generado y los escenarios .feature.

¿Debo llevar las documentación antigua de las APIs a la nueva versión del DO? arrow2-down

Normalmente se presentan dos casos en esta situación:

  • Que requieras agregar una nueva API a un producto con APIs que tengan documentación antigua.
    Si no se había superado fase de pruebas vas a necesitar el insumo de los escenarios .feature con marcación Karate; es decir, que deberás volcar el contenido de los DO existentes en el nuevo formato.
  • Que debas versionar una API porque van a agregar nuevos campos.
    Para este caso debes pasar al nuevo formato del DO la información correspondiente a la(s) operación(es).
¿Qué debo tener presente cuando tengo varias operaciones que tienen objetos con nombres iguales? arrow2-down

  1. Verifica que tus objetos y los elementos que contenga sean exactamente iguales en cuanto a "nombre", "descripción", "clasificación de información", "tipo de parámetro" y ejemplo".

  2. Si los objetos que se han nombrado igual contienen elementos diferentes, hace que justamente no estemos hablando de la misma vista de esas entidades y te va ha arrojar error. Expresa funcionalmente esa diferencia cambiando el nombre de uno de los objetos o elementos, para aportar a la claridad en su alcance.