Skip to content

Fix typos in README #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
krzysdabro wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typos in README #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand All @@ -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`

Expand Down