diff --git a/README.md b/README.md index d0f54b2ff4ad78..e954b6f6ce1ca3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ It is a Flask extension to view incidents caused by the server. - +![Example Status](https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true) This is handled based on the requests that users make. Captures the server response and uses the conditional expression to quickly classify whether the request was successful or failed. @@ -15,6 +15,7 @@ This is handled based on the requests that users make. Captures the server respo Some of the HTTP states that the server takes into account are: - `200 OK`: Indicates that the request has been completed successfully. + - `404 Not Found`: Indicates that the requested resource is not available on the server. - `500 Internal Server Error`: Indicates that an internal server error has occurred while processing the client request. @@ -50,6 +51,12 @@ You can configure which routes you want to be shown: FlaskStatus(app, routes=['/']) ``` +The default path is: `/status`. Although you can configure the route. + +```py +FlaskStatus(app, url_prefix='/status') +``` + - Define routes. The use of docstring. It will be used to define the route name. `# ` ```py @@ -61,7 +68,7 @@ def index(): return 'Welcome to API!', 200 # 200 is the status code ``` -The default path is: `/status` +In case you have not defined the route name. By default, it will take the name of the endpoint role. ## API diff --git a/README_ES.md b/README_ES.md index ac9daf0c4e08a0..67ef654d8a59ba 100644 --- a/README_ES.md +++ b/README_ES.md @@ -4,7 +4,7 @@ Es una extensión de Flask para visualizar incidentes provocados por el servidor. - +![Example Status](https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true) Esto se maneja en función de las solicitudes que realizan los usuarios. Captura la respuesta del servidor y utiliza la expresión condicional para clasificar rápidamente si la solicitud fue exitosa o si ha fallado. @@ -15,6 +15,7 @@ Esto se maneja en función de las solicitudes que realizan los usuarios. Captura Algunos de los estados de HTTP que el servidor toma en cuenta son: - `200 OK`: Indica que la solicitud ha sido completada con éxito. + - `404 Not Found`: Indica que el recurso solicitado no se encuentra disponible en el servidor. - `500 Internal Server Error`: Indica que ha ocurrido un error interno en el servidor al procesar la solicitud del cliente. @@ -50,6 +51,12 @@ Puedes configurar qué rutas quieres que se muestren: FlaskStatus(app, routes=['/']) ``` +La ruta por defecto es: `/status`. Aunque puedes configurar la ruta. + +```py +FlaskStatus(app, url_prefix='/status') +``` + - Definir rutas. El uso de docstring. Se utilizará para definir el nombre de la ruta. `# ` ```py @@ -61,7 +68,7 @@ def index(): return 'Welcome to API!', 200 # 200 is the status code ``` -La ruta por defecto es: `/status` +En caso de que no hayas definido el nombre de la ruta. De forma predeterminada, tomará el nombre de la función del endpoint. ## API