@@ -22,6 +22,7 @@ security:
22
22
tags :
23
23
- name : Control Planes
24
24
- name : Control Plane Groups
25
+ - name : Resource Quotas
25
26
- name : Auth Settings
26
27
- name : Invites
27
28
- name : Roles
40
41
- name : Transit Gateways
41
42
- name : Provider Accounts
42
43
- name : Custom Domains
43
- - name : Resource Quotas
44
44
- name : Resource Configurations
45
45
- name : Resource Availability
46
46
- description : DP Nodes
@@ -13199,6 +13199,147 @@ components:
13199
13199
- name
13200
13200
- config
13201
13201
Route :
13202
+ oneOf :
13203
+ - $ref : ' #/components/schemas/RouteJson'
13204
+ - $ref : ' #/components/schemas/RouteExpression'
13205
+ RouteExpression :
13206
+ x-speakeasy-entity : GatewayRouteExpression
13207
+ description : >-
13208
+ Route entities define rules to match client requests. Each Route is
13209
+ associated with a Service, and a Service may have multiple Routes
13210
+ associated to it. Every request matching a given Route will be proxied
13211
+ to its associated Service. The combination of Routes and Services (and
13212
+ the separation of concerns between them) offers a powerful routing
13213
+ mechanism with which it is possible to define fine-grained entry-points
13214
+ in Kong leading to different upstream services of your infrastructure.
13215
+ You need at least one matching rule that applies to the protocol being
13216
+ matched by the Route.
13217
+ type : object
13218
+ properties :
13219
+ created_at :
13220
+ description : Unix epoch when the resource was created.
13221
+ type : integer
13222
+ readOnly : true
13223
+ expression :
13224
+ description : >-
13225
+ Use Router Expression to perform route match. This option is only
13226
+ available when `router_flavor` is set to `expressions`.
13227
+ type : string
13228
+ nullable : true
13229
+ https_redirect_status_code :
13230
+ description : >-
13231
+ The status code Kong responds with when all properties of a Route
13232
+ match except the protocol i.e. if the protocol of the request is
13233
+ `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if
13234
+ the field is set to 301, 302, 307 or 308. Note: This config applies
13235
+ only if the Route is configured to only accept the `https` protocol.
13236
+ type : integer
13237
+ enum :
13238
+ - 426
13239
+ - 301
13240
+ - 302
13241
+ - 307
13242
+ - 308
13243
+ nullable : true
13244
+ id :
13245
+ type : string
13246
+ nullable : true
13247
+ name :
13248
+ description : >-
13249
+ The name of the Route. Route names must be unique, and they are case
13250
+ sensitive. For example, there can be two different Routes named
13251
+ "test" and "Test".
13252
+ type : string
13253
+ nullable : true
13254
+ path_handling :
13255
+ description : >-
13256
+ Controls how the Service path, Route path and requested path are
13257
+ combined when sending a request to the upstream. See above for a
13258
+ detailed description of each behavior.
13259
+ type : string
13260
+ enum :
13261
+ - v0
13262
+ - v1
13263
+ nullable : true
13264
+ preserve_host :
13265
+ description : >-
13266
+ When matching a Route via one of the `hosts` domain names, use the
13267
+ request `Host` header in the upstream request headers. If set to
13268
+ `false`, the upstream `Host` header will be that of the Service's
13269
+ `host`.
13270
+ type : boolean
13271
+ nullable : true
13272
+ priority :
13273
+ type : integer
13274
+ nullable : true
13275
+ protocols :
13276
+ description : >-
13277
+ An array of the protocols this Route should allow. See the [Route
13278
+ Object](#route-object) section for a list of accepted protocols.
13279
+ When set to only `"https"`, HTTP requests are answered with an
13280
+ upgrade error. When set to only `"http"`, HTTPS requests are
13281
+ answered with an error.
13282
+ type : array
13283
+ items :
13284
+ enum :
13285
+ - grpc
13286
+ - grpcs
13287
+ - http
13288
+ - https
13289
+ - tcp
13290
+ - tls
13291
+ - tls_passthrough
13292
+ - udp
13293
+ - ws
13294
+ - wss
13295
+ type : string
13296
+ nullable : true
13297
+ request_buffering :
13298
+ description : >-
13299
+ Whether to enable request body buffering or not. With HTTP 1.1, it
13300
+ may make sense to turn this off on services that receive data with
13301
+ chunked transfer encoding.
13302
+ type : boolean
13303
+ nullable : true
13304
+ response_buffering :
13305
+ description : >-
13306
+ Whether to enable response body buffering or not. With HTTP 1.1, it
13307
+ may make sense to turn this off on services that send data with
13308
+ chunked transfer encoding.
13309
+ type : boolean
13310
+ nullable : true
13311
+ service :
13312
+ description : >-
13313
+ The Service this Route is associated to. This is where the Route
13314
+ proxies traffic to.
13315
+ type : object
13316
+ additionalProperties : false
13317
+ nullable : true
13318
+ properties :
13319
+ id :
13320
+ type : string
13321
+ x-foreign : true
13322
+ x-speakeasy-terraform-plan-only : true
13323
+ default : null
13324
+ strip_path :
13325
+ description : >-
13326
+ When matching a Route via one of the `paths`, strip the matching
13327
+ prefix from the upstream request URL.
13328
+ type : boolean
13329
+ nullable : true
13330
+ tags :
13331
+ description : >-
13332
+ An optional set of strings associated with the Route for grouping
13333
+ and filtering.
13334
+ type : array
13335
+ items :
13336
+ type : string
13337
+ updated_at :
13338
+ description : Unix epoch when the resource was last updated.
13339
+ type : integer
13340
+ readOnly : true
13341
+ additionalProperties : false
13342
+ RouteJson :
13202
13343
description : >-
13203
13344
Route entities define rules to match client requests. Each Route is
13204
13345
associated with a Service, and a Service may have multiple Routes
@@ -13239,9 +13380,9 @@ components:
13239
13380
interpreted as a regular expression.
13240
13381
type : object
13241
13382
additionalProperties :
13242
- type : array
13243
13383
items :
13244
13384
type : string
13385
+ type : array
13245
13386
nullable : true
13246
13387
hosts :
13247
13388
description : >-
@@ -13445,6 +13586,12 @@ components:
13445
13586
type : integer
13446
13587
type : object
13447
13588
nullable : true
13589
+ expression :
13590
+ description : >-
13591
+ Use Router Expression to perform route match. This option is only
13592
+ available when `router_flavor` is set to `expressions`.
13593
+ type : string
13594
+ nullable : true
13448
13595
headers :
13449
13596
description : >-
13450
13597
One or more lists of values indexed by header name that will cause
@@ -13455,9 +13602,9 @@ components:
13455
13602
interpreted as a regular expression.
13456
13603
type : object
13457
13604
additionalProperties :
13458
- type : array
13459
13605
items :
13460
13606
type : string
13607
+ type : array
13461
13608
nullable : true
13462
13609
hosts :
13463
13610
description : >-
@@ -13522,6 +13669,9 @@ components:
13522
13669
`host`.
13523
13670
type : boolean
13524
13671
nullable : true
13672
+ priority :
13673
+ type : integer
13674
+ nullable : true
13525
13675
protocols :
13526
13676
description : >-
13527
13677
An array of the protocols this Route should allow. See the [Route
0 commit comments