Skip to content

docs: Document route options in manifest schema #4425

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

Merged
philippthun merged 2 commits into from
Jul 3, 2025
Merged

docs: Document route options in manifest schema #4425

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afa7a7d
docs: Document route options in manifest schema
b1tamara Jul 1, 2025
4f09d43
docs: remove surrounding pipes from table
b1tamara Jul 2, 2025
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
14 changes: 13 additions & 1 deletion docs/v3/source/includes/resources/manifests/_object.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

#### <a name="space-manifest-per-route-options-level-configuration"></a> 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`


#### <a name="space-manifest-service-level-configuration"></a> Service-level configuration
This configuration is _creating_ new service bindings between the app and a service instance. The `services` field can
Expand Down