Apicurio Studio
No, no debes incluir comillas dobles ni simples en el ejemplo, Apicurio agregará automáticamente las comillas a los ejemplos.
Si se han definido anteriormente en otras API esquemas que se pueden reusar en la nuestra, se debe hacer uso de la opción "import schema" desde el apartado de "data types".
Se debe garantizar que para todo query o path parameter definido se asigne una entrada de cada ejemplo y que tenga correspondencia con los que se definan para la respuesta.
Se deben documentar la descripción breve (summary) y detallada (description), a nivel de la(s) operación(es) a usar de un path (POST, GET, PUT, PATCH, DELETE)
Ten presente que no debes hacerlo a nivel del path, te va a generar inconvenientes con el pipeline de industrialización.
En el apartado "SECURITY REQUIREMENTS" puedes manejar la combinación de los esquemas de seguridad que se requieran para cada operación.
Se debe usar el path en la plantilla que coincida con ese mecanismo de seguridad.
Si se puede usar, la recomendación es usar la misma estructura que se tiene para los códigos 200 y modificarla en base a esta; igualmente revisar que datos deben manejarse en el header para este tipo de respuesta.
No, el error 404 aplica solo en la consulta cuando no se encuentra información para la misma.
Primero revisa la correcta conexión de la VPN, este es el error más común. En caso de no funcionar cambia de navegador o reinicia el navegador. Si persiste el error puedes contactarnos a través del chat o formulario de contáctanos.
Utiliza tu usuario y contraseña de red; es decir el usuario y contraseña con los que accedemos a nuestro PC, en caso de ser empleado Bancolombia, o las credenciales con las que accedemos a los recursos de office en caso de ser empleado proveedor.
En Properties, Tipo String y se selecciona formato DateTime.
En la pestaña de Data Type Property - 1 Enter Basic Information en el campo description.
El horario de funcionamiento es de 5am a 8pm de lunes a sábado.
No es recomendable que fijes ejemplos a nivel de la definición de este tipo de campo. Pero sí garantizar que se tengan escenarios, donde se documente el ejemplo.
Sí, es posible cargar un archivo con extensión .yaml en Apicurio directamente. Sin embargo, esta práctica no es recomendada, la forma correcta es que utilices la plantilla que se encuentra habilitada en el sitio de gobierno y allí editar lo que necesites acorde a tu API.
Sólo tendrán acceso los analistas SOA y POs. Sin embargo, es importante que tengas presente que el único rol autorizado para editar es el de analista SOA, es responsabilidad del PO acceder siempre con modo de visualización.
Para saber más de cómo acceder si eres PO, te invitamos a ver este video.
En la definición de este tipo de campos no se recomienda dejar ejemplos; esta información genera mayor valor agregado si se garantizan en los escenarios funcionales.