Borrador editorial publicado para consulta. La revisión factual y lingüística está pendiente. Los ejemplos son ilustrativos.
Decisión y alcance
La documentación debe permitir implementar y operar el intercambio sin conocimiento oral oculto. Incluye objetos, campos, autenticación, permisos, ejemplos, errores y límites. Identifica responsable y versión del contrato de datos y cómo avisar a los equipos consumidores antes de un cambio incompatible.
Ejemplo ilustrativo
Ejemplo ilustrativo: otro equipo envía solicitudes con una referencia única. La guía muestra un caso válido, uno rechazado y el resultado de repetir el envío. Explica qué confirmación significa recibido y cuál significa aplicado en el sistema.
Criterio de aceptación
Pide a alguien ajeno a la implementación recorrer un ejemplo en un entorno separado. Corrige pasos implícitos y diferencias con el comportamiento real. Acepta la guía cuando el equipo receptor puede probar éxito, error y recuperación con las instrucciones disponibles.
Puntos clave
- Acepta la guía cuando el equipo receptor puede probar éxito, error y recuperación con las instrucciones disponibles.