diff --git a/api/README.md b/api/README.md index d63fbe4..7119543 100644 --- a/api/README.md +++ b/api/README.md @@ -75,7 +75,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogrepository/v1/stat "udp-sender": "stopped", "uftp": "stopped", "bttrack": "stopped", - "btlaunchmany": "stopped" + "btlaunchmany.bittornado": "stopped" } } ``` @@ -323,7 +323,8 @@ curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogrepository/v1/t Se importará una imagen de un repositorio remoto al repositorio local. Se puede hacer con el script "**importImage.py**", que debe ser llamado por el endpoint. **NOTA**: El script requiere que se le pase el nombre de la imagen (con extensión) como primer parámetro, la IP o hostname del repositorio remoto como segundo parámetro, y el usuario remoto como tercer parámetro. Estos parámetros deben enviarse desde ogCore (en el JSON), porque el repositorio local no puede extraer la información de la imagen de un ID almacenado en un repositorio remoto. -**NOTA2**: Este endpoint es asíncrono, ya que puede tardar mucho tiempo, por lo que solo informa de que la imagen se está importando, y abre un proceso paralelo, que avisará a ogCore cuando finalice la tarea (llamando a un endpoint de ogCore). +**NOTA2**: Este endpoint es asíncrono, ya que puede tardar mucho tiempo, por lo que solo informa de que la imagen se está transfiriendo, y abre un proceso paralelo, que avisará a ogCore cuando finalice la tarea (llamando a un endpoint de ogCore). +**NOTA3**: Este endpoint comprueba si la importación se ha realizado correctamente, comparando el contenido de los archivos "sum" y "size" con los valores reales (que vuelve a calcular). Si la importación ha sido correcta llama al script "createTorrentSum.py", para crear el archivo ".torrent" (que debe crearse desde el repositorio en el que esté), y actualizar la info del repositorio. Si la importación no ha sido correcta (porque la imagen no ha pasado el check de integridad), borra los archivos importados. **URL:** `/ogrepository/v1/repo/images` **Método HTTP:** POST @@ -349,7 +350,8 @@ curl -X POST -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d Se exportará una imagen del repositorio local a un repositorio remoto. Se puede hacer con el script "**exportImage.py**", que debe ser llamado por el endpoint. **NOTA**: El script requiere que se le pase el nombre de la imagen (con extensión) como primer parámetro, la IP o hostname del repositorio remoto como segundo parámetro, y el usuario remoto como tercer parámetro. El primer parámetro se obtiene en la API, a partir del ID de la imagen (que corresponde al contenido del archivo "full.sum"), pero la IP del repositorio remoto y el usuario remoto deben enviarse desde ogCore (en el JSON). -**NOTA2**: Este endpoint es asíncrono, ya que puede tardar mucho tiempo, por lo que solo informa de que la imagen se está exportando, y abre un proceso paralelo, que avisará a ogCore cuando finalice la tarea (llamando a un endpoint de ogCore). +**NOTA2**: Este endpoint puede tardar mucho tiempo, pero no lo hemos hecho asíncrono (porque no es llamado desde el portal), por lo que siempre informará del resultado final de la ejecución (a diferencia del endpoint "Importar una Imagen"), pero dependiendo del tamaño de la imagen, puede tardar bastante. +**NOTA3**: Este endpoint no genera el archivo ".torrent", ni comprueba si la exportación se ha realizado correctamente, por lo que posteriormente se debe llamar al endpoint "Crear archivos auxiliares" (para crear el archivo ".torrent" y actualizar el repositorio) y al endpoint "Chequear integridad de Imagen", ambos desde el equipo destino. No es realmente necesario llamar a este último endpoint, pero si recomendado. **URL:** `/ogrepository/v1/repo/images` **Método HTTP:** PUT @@ -367,7 +369,7 @@ curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d **Respuestas:** - **Código 500 Internal Server Error:** Ocurrió un error al exportar la imagen. - **Código 400 Bad Request:** No se ha encontrado la imagen y/o el equipo remoto especificados. -- **Código 200 OK:** La imagen se está exportando. +- **Código 200 OK:** La imagen se ha exportando exitosamente. --- ### Crear archivos auxiliares