From afa7a7d9f7d1b0e6b5858d65b6faeb6c1a5a3a3b Mon Sep 17 00:00:00 2001 From: Tamara Boehm Date: Tue, 1 Jul 2025 12:38:28 +0200 Subject: [PATCH 1/2] docs: Document route options in manifest schema --- .../includes/resources/manifests/_object.md.erb | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/v3/source/includes/resources/manifests/_object.md.erb b/docs/v3/source/includes/resources/manifests/_object.md.erb index 8a24c279be8..0cefb1e1bee 100644 --- a/docs/v3/source/includes/resources/manifests/_object.md.erb +++ b/docs/v3/source/includes/resources/manifests/_object.md.erb @@ -28,6 +28,9 @@ applications: - route: route.example.com - route: another-route.example.com protocol: http2 + - route: route-with-options.example.com + options: + loadbalancing: least-connection services: - my-service1 - my-service2 @@ -139,7 +142,16 @@ will be updated for any existing route mapping. Name | Type | Description ---- | ---- | ----------- **route** | _string_ | **(Required)** The route URI. Example: `host.domain.com` -**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp`. +**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp` +**options** | _object_ | A key-value mapping of configuration [options](#space-manifest-per-route-options-level-configuration) to be applied to the specific application route + +#### Per-Route Options-level configuration +This configuration allows additional key-value options for the specific application route. + +| Name | Type | Description | +|-------------------|----------|-----------------------------------------------------------------------------------------------------| +| **loadbalancing** | _string_ | The load-balancer associated with this route. Valid values are ‘round-robin’ and ‘least-connection’ | + #### Service-level configuration This configuration is _creating_ new service bindings between the app and a service instance. The `services` field can From 4f09d43f0a1a28339bc267fd1327d5e00ab98191 Mon Sep 17 00:00:00 2001 From: Tamara Boehm Date: Wed, 2 Jul 2025 12:19:05 +0200 Subject: [PATCH 2/2] docs: remove surrounding pipes from table --- docs/v3/source/includes/resources/manifests/_object.md.erb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/v3/source/includes/resources/manifests/_object.md.erb b/docs/v3/source/includes/resources/manifests/_object.md.erb index 0cefb1e1bee..aaaea08b8f2 100644 --- a/docs/v3/source/includes/resources/manifests/_object.md.erb +++ b/docs/v3/source/includes/resources/manifests/_object.md.erb @@ -148,9 +148,9 @@ Name | Type | Description #### Per-Route Options-level configuration This configuration allows additional key-value options for the specific application route. -| Name | Type | Description | -|-------------------|----------|-----------------------------------------------------------------------------------------------------| -| **loadbalancing** | _string_ | The load-balancer associated with this route. Valid values are ‘round-robin’ and ‘least-connection’ | +Name | Type | Description +---- | ---- | ----------- + **loadbalancing** | _string_ | The load-balancer associated with this route. Valid values are `round-robin` and `least-connection` #### Service-level configuration