Skip to content

Commit 1f3d714

Browse files
committed
chore(docs): format vars
1 parent 2df90b6 commit 1f3d714

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,33 +53,33 @@ uvicorn --factory stac_auth_proxy:create_app
5353

5454
The application is configurable via environment variables.
5555

56-
- **Core**
57-
- `UPSTREAM_URL`, STAC API URL
56+
- Core
57+
- **`UPSTREAM_URL`**, STAC API URL
5858
- **Type:** HTTP(S) URL
5959
- **Required:** Yes
6060
- **Example:** `https://your-stac-api.com/stac`
61-
- `WAIT_FOR_UPSTREAM`, wait for upstream API to become available before starting proxy
61+
- **`WAIT_FOR_UPSTREAM`**, wait for upstream API to become available before starting proxy
6262
- **Type:** boolean
6363
- **Required:** No, defaults to `true`
6464
- **Example:** `false`, `1`, `True`
65-
- `HEALTHZ_PREFIX`, path prefix for health check endpoints
65+
- **`HEALTHZ_PREFIX`**, path prefix for health check endpoints
6666
- **Type:** string
6767
- **Required:** No, defaults to `/healthz`
6868
- **Example:** `''` (disabled)
69-
- **Authentication**
70-
- `OIDC_DISCOVERY_URL`, OpenID Connect discovery document URL
69+
- Authentication
70+
- **`OIDC_DISCOVERY_URL`**, OpenID Connect discovery document URL
7171
- **Type:** HTTP(S) URL
7272
- **Required:** Yes
7373
- **Example:** `https://auth.example.com/.well-known/openid-configuration`
74-
- `OIDC_DISCOVERY_INTERNAL_URL`, internal network OpenID Connect discovery document URL
74+
- **`OIDC_DISCOVERY_INTERNAL_URL`**, internal network OpenID Connect discovery document URL
7575
- **Type:** HTTP(S) URL
7676
- **Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
7777
- **Example:** `http://auth/.well-known/openid-configuration`
78-
- `DEFAULT_PUBLIC`, default access policy for endpoints
78+
- **`DEFAULT_PUBLIC`**, default access policy for endpoints
7979
- **Type:** boolean
8080
- **Required:** No, defaults to `false`
8181
- **Example:** `false`, `1`, `True`
82-
- `PRIVATE_ENDPOINTS`, endpoints explicitly marked as requiring authentication, used when `DEFAULT_PUBLIC == True`
82+
- **`PRIVATE_ENDPOINTS`**, endpoints explicitly marked as requiring authentication, used when `DEFAULT_PUBLIC == True`
8383
- **Type:** JSON object mapping regex patterns to HTTP methods OR tuples of HTTP methods and an array of strings representing required scopes
8484
- **Required:** No, defaults to the following:
8585
```json
@@ -91,7 +91,7 @@ The application is configurable via environment variables.
9191
"^/collections/([^/]+)/bulk_items$": ["POST"]
9292
}
9393
```
94-
- `PUBLIC_ENDPOINTS`, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
94+
- **`PUBLIC_ENDPOINTS`**, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
9595
- **Type:** JSON object mapping regex patterns to HTTP methods
9696
- **Required:** No, defaults to the following:
9797
```json
@@ -100,12 +100,12 @@ The application is configurable via environment variables.
100100
"^/api$": ["GET"]
101101
}
102102
```
103-
- `OPENAPI_SPEC_ENDPOINT`, path of OpenAPI specification, used for augmenting spec response with auth configuration
103+
- **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
104104
- **Type:** string or null
105105
- **Required:** No, defaults to `null` (disabled)
106106
- **Example:** `/api`
107-
- **Filtering**
108-
- `ITEMS_FILTER`, [cql2 expression](https://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) generator for item-level filtering
107+
- Filtering
108+
- **`ITEMS_FILTER`**, [cql2 expression](https://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) generator for item-level filtering
109109
- **Type:** JSON object with class configuration
110110
- **Required:** No, defaults to `null` (disabled)
111111
- **Components**:

0 commit comments

Comments
 (0)