From 868662296b60452e1c4bcd85111e12e2d6b2cf28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20D=C4=85browski?= Date: Mon, 29 May 2023 01:05:40 +0200 Subject: [PATCH] Fix typos in README --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d7d9991..4b0e277 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,10 @@ Pass environment variables with Docker: ----- ## Environment Variables -| Name | Description | Default | +| Name | Description | Default | | :---: | :---: | :---: | | PORT | What port the service should listen on | 8080 | -| ENABLE_TLS | Whether to use TLS for HTTSP or use HTTP | false | +| ENABLE_TLS | Whether to use TLS for HTTPS or use HTTP | false | | OPENAPI_PATH | What path to serve the OpenAPI document on | /.ambassador-internal/openapi-docs | | ZIPKIN_SERVER | The Zipkin service for reporting traces to | N/A | | ZIPKIN_PORT | The port for the Zipkin service | 9411 | @@ -80,7 +80,7 @@ Pass environment variables with Docker: Ex: `curl -kv https://{IP_ADDR}/backend/debug/{path}` ----- -- `health` +- `/health` **GET:** Returns a 200 OK when the service is functioning. @@ -111,13 +111,13 @@ Pass environment variables with Docker: **GET:** returns a list of files available to be downloaded. - **POST:** Uploads a file to the service to be downloaded later. Overwrites existing files if provided with the same name as an existing file. Uses the path as the name for the file. + **POST:** Uploads a file to the service to be downloaded later. Overwrites existing files if provided with the same name as an existing file. Uses the path as the name for the file. Ex: `curl -kv https://{IP_ADDR}/backend/files/` Ex: `curl -kv --form "file=@README.md" https://{IP_ADDR}/backend/files/` - > **Note:** The `FILE_PATH` environment varialbe is used to configure a custom path for storing files if using a persistent volume in Kubernetes. Otherwise it will default to storing files ephemerally inside the container. + > **Note:** The `FILE_PATH` environment variable is used to configure a custom path for storing files if using a persistent volume in Kubernetes. Otherwise it will default to storing files ephemerally inside the container. > **Note:** For successful file uploads it expects the file to be passed in a value called `file` exactly as shown in the example. @@ -126,7 +126,7 @@ Pass environment variables with Docker: ----- - `/files/*` - **GET:** returns a file of the provided name if it exists or a 404 if it cannot find the file. The container ships with a file `edgy.jepg` for testing. + **GET:** returns a file of the provided name if it exists or a 404 if it cannot find the file. The container ships with a file `edgy.jpeg` for testing. Ex: `curl -kv https://{IP_ADDR}/backend/files/edgy.jpeg`