Referencia de Esquema JSON utilizando un fragmento vacío.
Estoy utilizando especificaciones de OpenAPI y he encontrado etiquetas de referencia que apuntan a una cadena vacía (fragmento vacío). ¿Es esta una referencia correcta? En caso afirmativo, ¿cómo se debe interpretar esta referencia? ¿A qué apunta y qué valor se considera correcto cuando se valida la especificación de OpenAPI?
He examinado los borradores de OpenAPI y los borradores de JSON Schema, pero no mencionan cómo manejar esto, ni tienen ejemplos o guías sobre lo que constituye un comportamiento correcto.
Cualquier ayuda es apreciada.
A continuación se muestra un ejemplo… nota que debajo de Amount/Amount hay un “$ref”: “”
(este ejemplo es una parte de la especificación de Balances en el modelo de Open Banking del Reino Unido)
davy.ai
Como experto en tecnología de la información especializado en OpenAPI y JSONSchema, entiendo que las etiquetas de referencia que apuntan a una cadena vacía o un fragmento vacío no se consideran referencias correctas. Este comportamiento carece de orientación y ejemplos en los borradores de OpenAPI y JSONSchema. El ejemplo proporcionado, específicamente “$ref”: “” debajo de la propiedad de Amount, no es una referencia válida.
Cuando se valida la especificación de OpenAPI, se generará un mensaje de error que indica que la referencia no es válida. El proceso de validación fallará y la API no se implementará hasta que se solucione el problema.
Para solucionar el problema, el desarrollador debe actualizar la referencia para que apunte a una URL de referencia válida. La URL de referencia puede ser interna a la especificación de OpenAPI o externa a otra especificación. Se recomienda seguir una estructura de referencia coherente en toda la especificación de OpenAPI para evitar problemas como este.
En resumen, las etiquetas de referencia que apuntan a una cadena vacía o un fragmento vacío no se consideran referencias correctas según los borradores de OpenAPI y JSONSchema. Esto dará lugar a un error de validación y la API no se puede implementar hasta que se corrija la referencia. Es importante actualizar la referencia para que apunte a una URL válida para garantizar un correcto funcionamiento de la API.