diff --git a/README.md b/README.md index fdf416f..63cbaf1 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,6 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/config - **min-release**: La versión mínima recomendada para la instalación de imágenes oglives. -Estas definiciones proporcionan una comprensión clara de cada uno de los parámetros de contenido dentro de la configuración del ogboot. - **Código 400 Bad Request:** La solicitud es incorrecta. La configuración del ogboot no se ha obtenido correctamente. @@ -101,16 +100,11 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/status - - - - - ### Mostrar Información de Todos los Clientes ogLive Instalados Muestra información en formato JSON sobre todos los clientes ogLive instalados. -**URL:** `/ogboot/v1/clients/oglives` +**URL:** `/ogboot/v1/oglives` **Método HTTP:** GET **Ejemplo de Solicitud:** @@ -159,7 +153,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/og Muestra información en formato JSON sobre un cliente ogLive instalado específico. -**URL:** `/ogboot/v1/clients/oglives/{Index}` +**URL:** `/ogboot/v1/oglives/{Index}` **Método HTTP:** GET **Parámetros de la URL:** @@ -189,7 +183,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/og Muestra información en formato JSON sobre el cliente ogLive predeterminado. -**URL:** `/ogboot/v1/clients/oglives/default` +**URL:** `/ogboot/v1/oglives/default` **Método HTTP:** GET **Ejemplo de Solicitud:** @@ -219,7 +213,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/og Establece un nuevo cliente ogLive como predeterminado utilizando su índice. -**URL:** +**URL:** `/ogboot/v1/oglives/default` **Método HTTP:** POST **Parámetros de la URL:** @@ -259,16 +253,15 @@ curl -X POST -H "Authorization: $API_KEY" -d "ISO=ogLive-focal-5.13.0-27-beta-am - ### Desinstalar Cliente ogLive Desinstala un cliente ogLive específico y elimina su imagen asociada. -**URL:** `/ogboot/v1/oglives/{Index/iso}` +**URL:** `/ogboot/v1/oglives/{Index}` **Método HTTP:** DELETE **Parámetros de la URL:** -- `{Index/iso}`: El índice o nombre de archivo ISO del cliente ogLive que se desinstalará y eliminará. +- `{Index}`: El índice deL archivo ISO del cliente ogLive que se desinstalará y eliminará. **Ejemplo de Solicitud:** @@ -343,13 +336,14 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxes **Respuestas:** - **Código 200 OK:** La lista de todos los archivos de arranque se obtuvo exitosamente. - **Contenido:** Lista de archivos de arranque en formato JSON. +- **Código 500 Internal Server Error:** Ocurrió un error al intentar obtener la lista de todos los archivos de arranque disponibles. ### Obtener Configuración de Arranque Obtiene el contenido del archivo de configuración de arranque específico para un cliente utilizando su dirección MAC. -**URL:** `/ogboot/v1/clients/pxes/{mac}` +**URL:** `/ogboot/v1/pxes/{mac}` **Método HTTP:** GET **Parámetros de la URL:** @@ -401,13 +395,13 @@ curl -X POST -H "Authorization: $API_KEY" -d '{"mac": "00:50:56:22:11:12", "conf **Respuestas:** - **Código 200 OK:** El archivo de arranque se creó exitosamente. - **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud. - +- **Código 500 Internal Server Error:** Ocurrió un error al subir el archivo de arranque. ### Eliminar Archivo de Arranque Elimina un archivo de arranque específico utilizando su identificador único. -**URL:** `/ogboot/v1/clients/pxes` +**URL:** `/ogboot/v1/pxes/{MAC}` **Método HTTP:** DELETE **Parámetros de la URL:** @@ -422,6 +416,7 @@ curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients **Respuestas:** - **Código 200 OK:** El archivo de arranque se eliminó correctamente. - **Código 404 Not Found:** No se encontró ningún archivo de arranque con el identificador único especificado. +- **Código 500 Internal Server Error:** Ocurrió un error al eliminar el archivo de arranque. @@ -444,7 +439,7 @@ curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d **Respuestas:** - **Código 200 OK:** El repositorio de arranque se actualizó exitosamente con los archivos modificados. - **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud. - +- **Código 500 Internal Server Error:** Ocurrió un error al actualizar el archivo de arranque. ### Obtener Todas las Plantillas @@ -463,7 +458,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templa **Respuestas:** - **Código 200 OK:** La lista de todas las plantillas de arranque se obtuvo exitosamente. - **Contenido:** Lista de plantillas de arranque en formato JSON. - +- **Código 500 Internal Server Error:** Ocurrió un error al obtener las plantillas de arranque. ### Obtener Contenido de la Plantilla @@ -496,6 +491,8 @@ boot **Respuestas:** - **Código 200 OK:** El contenido de la plantilla de arranque se obtuvo exitosamente. - **Contenido:** Contenido de la plantilla de arranque en formato adecuado para su uso. +- **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud. +- **Código 500 Internal Server Error:** Ocurrió un error al obtener la plantilla de arranque. --- @@ -546,6 +543,7 @@ boot - **Código 200 OK:** La plantilla de arranque se creó exitosamente. - **Contenido:** Plantilla generada a partir de los parámetros pasados en la petición. - **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud. +- **Código 500 Internal Server Error:** Ocurrió un error al crear la plantilla de arranque. ### Regenerar Plantilla @@ -567,6 +565,7 @@ curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templa **Respuestas:** - **Código 200 OK:** El contenido de la plantilla de arranque se regeneró exitosamente. - **Código 404 Not Found:** No se encontró ninguna plantilla de arranque con el nombre especificado. +- **Código 500 Internal Server Error:** Ocurrió un error al regenerar la plantilla de arranque. --- @@ -589,4 +588,5 @@ curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-tem **Respuestas:** - **Código 200 OK:** La plantilla de arranque se eliminó correctamente. - **Código 404 Not Found:** No se encontró ninguna plantilla de arranque con el nombre especificado. +- **Código 500 Internal Server Error:** Ocurrió un error al eliminar la plantilla de arranque.