docs(user-guide): formatting

Author: alukach

docs/user-guide/configuration.md

@@ -8,57 +8,57 @@ The application is configurable via environment variables.
 
 : STAC API URL
 
-    **Type:** HTTP(S) URL  
-    **Required:** Yes  
+    **Type:** HTTP(S) URL
+    **Required:** Yes
     **Example:** `https://your-stac-api.com/stac`
 
 ### `WAIT_FOR_UPSTREAM`
 
 : Wait for upstream API to become available before starting proxy
 
-    **Type:** boolean  
-    **Required:** No, defaults to `true`  
+    **Type:** boolean
+    **Required:** No, defaults to `true`
     **Example:** `false`, `1`, `True`
 
 ### `CHECK_CONFORMANCE`
 
 : Ensure upstream API conforms to required conformance classes before starting proxy
 
-    **Type:** boolean  
-    **Required:** No, defaults to `true`  
+    **Type:** boolean
+    **Required:** No, defaults to `true`
     **Example:** `false`, `1`, `True`
 
 ### `ENABLE_COMPRESSION`
 
 : Enable response compression
 
-    **Type:** boolean  
-    **Required:** No, defaults to `true`  
+    **Type:** boolean
+    **Required:** No, defaults to `true`
     **Example:** `false`, `1`, `True`
 
 ### `HEALTHZ_PREFIX`
 
 : Path prefix for health check endpoints
 
-    **Type:** string  
-    **Required:** No, defaults to `/healthz`  
+    **Type:** string
+    **Required:** No, defaults to `/healthz`
     **Example:** `''` (disabled)
 
 ### `OVERRIDE_HOST`
 
 : Override the host header for the upstream API
 
-    **Type:** boolean  
-    **Required:** No, defaults to `true`  
+    **Type:** boolean
+    **Required:** No, defaults to `true`
     **Example:** `false`, `1`, `True`
 
 ### `ROOT_PATH`
 
 : Path prefix for the proxy API
 
-    **Type:** string  
-    **Required:** No, defaults to `''` (root path)  
-    **Example:** `/api/v1`  
+    **Type:** string
+    **Required:** No, defaults to `''` (root path)
+    **Example:** `/api/v1`
     **Note:** This is independent of the upstream API's path. The proxy will handle removing this prefix from incoming requests and adding it to outgoing links.
 
 ## Authentication
@@ -67,16 +67,16 @@ The application is configurable via environment variables.
 
 : OpenID Connect discovery document URL
 
-    **Type:** HTTP(S) URL  
-    **Required:** Yes  
+    **Type:** HTTP(S) URL
+    **Required:** Yes
     **Example:** `https://auth.example.com/.well-known/openid-configuration`
 
 ### `OIDC_DISCOVERY_INTERNAL_URL`
 
 : Internal network OpenID Connect discovery document URL
 
-    **Type:** HTTP(S) URL  
-    **Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`  
+    **Type:** HTTP(S) URL
+    **Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
     **Example:** `http://auth/.well-known/openid-configuration`
 
 ### `ALLOWED_JWT_AUDIENCES` 
@@ -86,22 +86,22 @@ The application is configurable via environment variables.
     **Type:** string  
     **Required:** No  
     **Example:** `https://auth.example.audience.1.net,https://auth.example.audience.2.net`
-    **Note** A comma-separated list of the intended recipient(s) of the JWT. At least one audience value must match the `aud` (audience) claim present in the incoming JWT. If undefined, the API will not impose a check on the `aud` claim
+    **Note:** A comma-separated list of the intended recipient(s) of the JWT. At least one audience value must match the `aud` (audience) claim present in the incoming JWT. If undefined, the API will not impose a check on the `aud` claim
 
 
 ### `DEFAULT_PUBLIC`
 
 : Default access policy for endpoints
 
-    **Type:** boolean  
-    **Required:** No, defaults to `false`  
+    **Type:** boolean
+    **Required:** No, defaults to `false`
     **Example:** `false`, `1`, `True`
 
 ### `PRIVATE_ENDPOINTS`
 
 : Endpoints explicitly marked as requiring authentication and possibly scopes
 
-    **Type:** JSON object mapping regex patterns to HTTP methods OR tuples of an HTTP method and string representing required scopes  
+    **Type:** JSON object mapping regex patterns to HTTP methods OR tuples of an HTTP method and string representing required scopes
     **Required:** No, defaults to the following:
     ```json
     {
@@ -117,7 +117,7 @@ The application is configurable via environment variables.
 
 : Endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
 
-    **Type:** JSON object mapping regex patterns to HTTP methods  
+    **Type:** JSON object mapping regex patterns to HTTP methods
     **Required:** No, defaults to the following:
     ```json
     {
@@ -134,8 +134,8 @@ The application is configurable via environment variables.
 
 : Enable authentication extension in STAC API responses
 
-    **Type:** boolean  
-    **Required:** No, defaults to `true`  
+    **Type:** boolean
+    **Required:** No, defaults to `true`
     **Example:** `false`, `1`, `True`
 
 ## OpenAPI / Swagger UI
@@ -152,22 +152,22 @@ The application is configurable via environment variables.
 
 : Name of the auth scheme to use in the OpenAPI spec
 
-    **Type:** string  
-    **Required:** No, defaults to `oidcAuth`  
+    **Type:** string
+    **Required:** No, defaults to `oidcAuth`
     **Example:** `jwtAuth`
 
 ### `OPENAPI_AUTH_SCHEME_OVERRIDE`
 
 : Override for the auth scheme in the OpenAPI spec
 
-    **Type:** JSON object  
-    **Required:** No, defaults to `null` (disabled)  
-    **Example:** 
+    **Type:** JSON object
+    **Required:** No, defaults to `null` (disabled)
+    **Example:**
         ```json
         {
-            "type": "http", 
-            "scheme": "bearer", 
-            "bearerFormat": "JWT", 
+            "type": "http",
+            "scheme": "bearer",
+            "bearerFormat": "JWT",
             "description": "Paste your raw JWT here. This API uses Bearer token authorization.\n"
         }
         ```
@@ -184,8 +184,8 @@ The application is configurable via environment variables.
 
 : Initialization options for the [Swagger UI OAuth2 configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) on custom Swagger UI
 
-    **Type:** JSON object  
-    **Required:** No, defaults to `null` (disabled)  
+    **Type:** JSON object
+    **Required:** No, defaults to `null` (disabled)
     **Example:** `{"clientId": "stac-auth-proxy", "usePkceWithAuthorizationCodeGrant": true}`
 
 ## Filtering
@@ -194,62 +194,62 @@ The application is configurable via environment variables.
 
 : CQL2 expression generator for item-level filtering
 
-    **Type:** JSON object with class configuration  
-    **Required:** No, defaults to `null` (disabled)  
+    **Type:** JSON object with class configuration
+    **Required:** No, defaults to `null` (disabled)
     **Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
 
 ### `ITEMS_FILTER_ARGS`
 
 : Positional arguments for CQL2 expression generator
 
-    **Type:** List of positional arguments used to initialize the class  
-    **Required:** No, defaults to `[]`  
+    **Type:** List of positional arguments used to initialize the class
+    **Required:** No, defaults to `[]`
     **Example:** `["org1"]`
 
 ### `ITEMS_FILTER_KWARGS`
 
 : Keyword arguments for CQL2 expression generator
 
-    **Type:** Dictionary of keyword arguments used to initialize the class  
-    **Required:** No, defaults to `{}`  
+    **Type:** Dictionary of keyword arguments used to initialize the class
+    **Required:** No, defaults to `{}`
     **Example:** `{"field_name": "properties.organization"}`
 
 ### `ITEMS_FILTER_PATH`
 
 : Regex pattern used to identify request paths that require the application of the items filter
 
-    **Type:** Regex string  
-    **Required:** No, defaults to `^(/collections/([^/]+)/items(/[^/]+)?$|/search$)`  
+    **Type:** Regex string
+    **Required:** No, defaults to `^(/collections/([^/]+)/items(/[^/]+)?$|/search$)`
     **Example:** `^(/collections/([^/]+)/items(/[^/]+)?$|/search$|/custom$)`
 
 ### `COLLECTIONS_FILTER_CLS`
 
 : CQL2 expression generator for collection-level filtering
 
-    **Type:** JSON object with class configuration  
-    **Required:** No, defaults to `null` (disabled)  
+    **Type:** JSON object with class configuration
+    **Required:** No, defaults to `null` (disabled)
     **Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
 
 ### `COLLECTIONS_FILTER_ARGS`
 
 : Positional arguments for CQL2 expression generator
 
-    **Type:** List of positional arguments used to initialize the class  
-    **Required:** No, defaults to `[]`  
+    **Type:** List of positional arguments used to initialize the class
+    **Required:** No, defaults to `[]`
     **Example:** `["org1"]`
 
 ### `COLLECTIONS_FILTER_KWARGS`
 
 : Keyword arguments for CQL2 expression generator
 
-    **Type:** Dictionary of keyword arguments used to initialize the class  
-    **Required:** No, defaults to `{}`  
+    **Type:** Dictionary of keyword arguments used to initialize the class
+    **Required:** No, defaults to `{}`
     **Example:** `{"field_name": "properties.organization"}`
 
 ### `COLLECTIONS_FILTER_PATH`
 
 : Regex pattern used to identify request paths that require the application of the collections filter
 
-    **Type:** Regex string  
-    **Required:** No, defaults to `^/collections(/[^/]+)?$`  
-    **Example:** `^.*?/collections(/[^/]+)?$` 
+    **Type:** Regex string
+    **Required:** No, defaults to `^/collections(/[^/]+)?$`
+    **Example:** `^.*?/collections(/[^/]+)?$`