Skip to content

chore: clarify supported HTTP methods in routes documentation #1422

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
sr-remsha merged 2 commits into from
Mar 25, 2026
Merged

chore: clarify supported HTTP methods in routes documentation #1422

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95f50a2
Clarify supported HTTP methods in routes documentation
sr-remsha Mar 25, 2026
f34464d
Fix methods key in rate paths configuration
sr-remsha Mar 25, 2026
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
4 changes: 2 additions & 2 deletions docs/dynamic-settings/routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ An object containing parameters for each [route](#routes).
- `body` - http response body.
* `rewritePath`: A boolean flag that indicates that the path to the upstream server will be replaced with the path of the original request, if this flag is set to `true`.
* `paths`: A list of paths to be matched request's path. If any path is matched, the request will be processed by this route. **Note**. A path can be a plain string or a regular expression.
* `methods`: A list of HTTP methods supported by this route.
* `methods`: A list of HTTP methods supported by this route. Supported methods: GET, POST, PUT, DELETE, HEAD and PATCH.
* `maxRetryAttempts`: Maximum number of [retry](https://docs.dialx.ai/platform/core/load-balancer#fallbacks) attempts in case if upstream server returns unsuccessful response code. In this case load balancer will try to find another upstream from the list of available upstreams.
* `order`: The value of this parameter determines the order within the global routes. The lower value means the higher priority. The value can't be negative integer. The default one is 2^31-1.
* `upstreams`: A list of upstream servers. Either `response` or `upstreams` must be provided. Refer to [routes.<route_name>.upstreams](#routesroute_nameupstreams) for more details.
Expand All @@ -41,7 +41,7 @@ A list of upstream servers with their parameters. Use to configure [load balanci
"vector_store_query": {
"paths": ["/v1/vector_store(/[^/]+)*$"],
"rewritePath": true,
"methods": ["GET", "HEAD"],
"": ["GET", "HEAD"],
"userRoles": ["role1"],
"upstreams": [
{
Expand Down
Loading