@@ -26,9 +26,9 @@ The following are built in transforms identified by their primary config key. Th
26
26
27
27
** Modifies the request path adding a prefix value**
28
28
29
- | Key | Value | Required |
30
- | -----| -------| ----------|
31
- | PathPrefix | A path starting with a '/' | yes |
29
+ | Key | Value | Required |
30
+ | ---------- | -------------------------- | -------- |
31
+ | PathPrefix | A path starting with a '/' | yes |
32
32
33
33
Config:
34
34
``` JSON
@@ -50,9 +50,9 @@ This will prefix the request path with the given value.
50
50
51
51
** Modifies the request path removing a prefix value**
52
52
53
- | Key | Value | Required |
54
- | -----| -------| ----------|
55
- | PathRemovePrefix | A path starting with a '/' | yes |
53
+ | Key | Value | Required |
54
+ | ---------------- | -------------------------- | -------- |
55
+ | PathRemovePrefix | A path starting with a '/' | yes |
56
56
57
57
Config:
58
58
``` JSON
@@ -75,9 +75,9 @@ This will remove the matching prefix from the request path. Matches are made on
75
75
76
76
** Replaces the request path with the specified value**
77
77
78
- | Key | Value | Required |
79
- | -----| -------| ----------|
80
- | PathSet | A path starting with a '/' | yes |
78
+ | Key | Value | Required |
79
+ | ------- | -------------------------- | -------- |
80
+ | PathSet | A path starting with a '/' | yes |
81
81
82
82
Config:
83
83
``` JSON
@@ -99,9 +99,9 @@ This will set the request path with the given value.
99
99
100
100
** Replaces the request path using a pattern template**
101
101
102
- | Key | Value | Required |
103
- | -----| -------| ----------|
104
- | PathPattern | A path template starting with a '/' | yes |
102
+ | Key | Value | Required |
103
+ | ----------- | ----------------------------------- | -------- |
104
+ | PathPattern | A path template starting with a '/' | yes |
105
105
106
106
Config:
107
107
``` JSON
@@ -119,23 +119,23 @@ This will set the request path with the given value and replace any `{}` segment
119
119
120
120
Example:
121
121
122
- | Step | Value |
123
- | ------| -------|
122
+ | Step | Value |
123
+ | ---------------- | ----------------------------------- |
124
124
| Route definition | ` /api/{plugin}/stuff/{**remainder} ` |
125
- | Request path | ` /api/v1/stuff/more/stuff ` |
126
- | Plugin value | ` v1 ` |
127
- | Remainder value | ` more/stuff ` |
128
- | PathPattern | ` /my/{plugin}/api/{**remainder} ` |
129
- | Result | ` /my/v1/api/more/stuff ` |
125
+ | Request path | ` /api/v1/stuff/more/stuff ` |
126
+ | Plugin value | ` v1 ` |
127
+ | Remainder value | ` more/stuff ` |
128
+ | PathPattern | ` /my/{plugin}/api/{**remainder} ` |
129
+ | Result | ` /my/v1/api/more/stuff ` |
130
130
131
131
## QueryValueParameter
132
132
133
133
** Adds or replaces parameters in the request query string**
134
134
135
- | Key | Value | Required |
136
- | -----| -------| ----------|
137
- | QueryValueParameter | Name of a query string parameter | yes |
138
- | Set/Append | Static value | yes |
135
+ | Key | Value | Required |
136
+ | ------------------- | -------------------------------- | -------- |
137
+ | QueryValueParameter | Name of a query string parameter | yes |
138
+ | Set/Append | Static value | yes |
139
139
140
140
Config:
141
141
``` JSON
@@ -156,21 +156,21 @@ This will add a query string parameter with the name `foo` and sets it to the st
156
156
157
157
Example:
158
158
159
- | Step | Value |
160
- | ------| -------|
161
- | Query | ` ?a=b ` |
162
- | QueryValueParameter | ` foo ` |
163
- | Append | ` remainder ` |
164
- | Result | ` ?a=b&foo=remainder ` |
159
+ | Step | Value |
160
+ | ------------------- | -------------------- |
161
+ | Query | ` ?a=b ` |
162
+ | QueryValueParameter | ` foo ` |
163
+ | Append | ` remainder ` |
164
+ | Result | ` ?a=b&foo=remainder ` |
165
165
166
166
## QueryRouteParameter
167
167
168
168
** Adds or replaces a query string parameter with a value from the route configuration**
169
169
170
- | Key | Value | Required |
171
- | -----| -------| ----------|
172
- | QueryRouteParameter | Name of a query string parameter | yes |
173
- | Set/Append | The name of a route value | yes |
170
+ | Key | Value | Required |
171
+ | ------------------- | -------------------------------- | -------- |
172
+ | QueryRouteParameter | Name of a query string parameter | yes |
173
+ | Set/Append | The name of a route value | yes |
174
174
175
175
Config:
176
176
``` JSON
@@ -191,22 +191,22 @@ This will add a query string parameter with the name `foo` and sets it to the va
191
191
192
192
Example:
193
193
194
- | Step | Value |
195
- | ------| -------|
196
- | Route definition | ` /api/{*remainder} ` |
197
- | Request path | ` /api/more/stuff ` |
198
- | Remainder value | ` more/stuff ` |
199
- | QueryRouteParameter | ` foo ` |
200
- | Append | ` remainder ` |
201
- | Result | ` ?foo=more/stuff ` |
194
+ | Step | Value |
195
+ | ------------------- | ------------------- |
196
+ | Route definition | ` /api/{*remainder} ` |
197
+ | Request path | ` /api/more/stuff ` |
198
+ | Remainder value | ` more/stuff ` |
199
+ | QueryRouteParameter | ` foo ` |
200
+ | Append | ` remainder ` |
201
+ | Result | ` ?foo=more/stuff ` |
202
202
203
203
## QueryRemoveParameter
204
204
205
205
** Removes the specified parameter from the request query string**
206
206
207
- | Key | Value | Required |
208
- | -----| -------| ----------|
209
- | QueryRemoveParameter | Name of a query string parameter | yes |
207
+ | Key | Value | Required |
208
+ | -------------------- | -------------------------------- | -------- |
209
+ | QueryRemoveParameter | Name of a query string parameter | yes |
210
210
211
211
Config:
212
212
``` JSON
@@ -224,20 +224,20 @@ This will remove a query string parameter with the name `foo` if present on the
224
224
225
225
Example:
226
226
227
- | Step | Value |
228
- | ------| -------|
229
- | Request path | ` ?a=b&foo=c ` |
230
- | QueryRemoveParameter | ` foo ` |
231
- | Result | ` ?a=b ` |
227
+ | Step | Value |
228
+ | -------------------- | ------------ |
229
+ | Request path | ` ?a=b&foo=c ` |
230
+ | QueryRemoveParameter | ` foo ` |
231
+ | Result | ` ?a=b ` |
232
232
233
233
## HttpMethodChange
234
234
235
235
** Changes the http method used in the request**
236
236
237
- | Key | Value | Required |
238
- | -----| -------| ----------|
239
- | HttpMethodChange | The http method to replace | yes |
240
- | Set | The new http method | yes |
237
+ | Key | Value | Required |
238
+ | ---------------- | -------------------------- | -------- |
239
+ | HttpMethodChange | The http method to replace | yes |
240
+ | Set | The new http method | yes |
241
241
242
242
Config:
243
243
``` JSON
@@ -260,9 +260,9 @@ This will change PUT requests to POST.
260
260
261
261
** Sets whether incoming request headers are copied to the outbound request**
262
262
263
- | Key | Value | Default | Required |
264
- | -----| -------| ---------| ----------|
265
- | RequestHeadersCopy | true/false | true | yes |
263
+ | Key | Value | Default | Required |
264
+ | ------------------ | ---------- | ------- | -------- |
265
+ | RequestHeadersCopy | true/false | true | yes |
266
266
267
267
Config:
268
268
``` JSON
@@ -282,9 +282,9 @@ This sets if all incoming request headers are copied to the proxy request. This
282
282
283
283
** Specifies if the incoming request Host header should be copied to the proxy request**
284
284
285
- | Key | Value | Default | Required |
286
- | -----| -------| ---------| ----------|
287
- | RequestHeaderOriginalHost | true/false | false | yes |
285
+ | Key | Value | Default | Required |
286
+ | ------------------------- | ---------- | ------- | -------- |
287
+ | RequestHeaderOriginalHost | true/false | false | yes |
288
288
289
289
Config:
290
290
``` JSON
@@ -303,10 +303,10 @@ This specifies if the incoming request Host header should be copied to the proxy
303
303
304
304
** Adds or replaces request headers**
305
305
306
- | Key | Value | Required |
307
- | -----| -------| ----------|
308
- | RequestHeader | The header name | yes |
309
- | Set/Append | The header value | yes |
306
+ | Key | Value | Required |
307
+ | ------------- | ---------------- | -------- |
308
+ | RequestHeader | The header name | yes |
309
+ | Set/Append | The header value | yes |
310
310
311
311
Config:
312
312
``` JSON
@@ -335,10 +335,10 @@ Note: setting "" as a header value is not recommended and can cause an undefined
335
335
336
336
** Adds or replaces a header with a value from the route configuration**
337
337
338
- | Key | Value | Required |
339
- | -----| -------| ----------|
340
- | RequestHeader | Name of a query string parameter | yes |
341
- | Set/Append | The name of a route value | yes |
338
+ | Key | Value | Required |
339
+ | ------------- | -------------------------------- | -------- |
340
+ | RequestHeader | Name of a query string parameter | yes |
341
+ | Set/Append | The name of a route value | yes |
342
342
343
343
Config:
344
344
``` JSON
@@ -357,14 +357,14 @@ transformBuilderContext.AddRequestHeaderRouteValue(headerName: "MyHeader", route
357
357
358
358
Example:
359
359
360
- | Step | Value |
361
- | ------| ---------------------|
362
- | Route definition | ` /api/{*remainder} ` |
363
- | Request path | ` /api/more/stuff ` |
364
- | Remainder value | ` more/stuff ` |
360
+ | Step | Value |
361
+ | ---------------------- | ------------------- |
362
+ | Route definition | ` /api/{*remainder} ` |
363
+ | Request path | ` /api/more/stuff ` |
364
+ | Remainder value | ` more/stuff ` |
365
365
| RequestHeaderFromRoute | ` foo ` |
366
- | Append | ` remainder ` |
367
- | Result | ` foo: more/stuff ` |
366
+ | Append | ` remainder ` |
367
+ | Result | ` foo: more/stuff ` |
368
368
369
369
This sets or appends the value for the named header with a value from the route configuration. Set replaces any existing header. Append adds an additional header with the given value.
370
370
Note: setting "" as a header value is not recommended and can cause an undefined behavior.
@@ -373,9 +373,9 @@ Note: setting "" as a header value is not recommended and can cause an undefined
373
373
374
374
** Removes request headers**
375
375
376
- | Key | Value | Required |
377
- | -----| -------| ----------|
378
- | RequestHeaderRemove | The header name | yes |
376
+ | Key | Value | Required |
377
+ | ------------------- | --------------- | -------- |
378
+ | RequestHeaderRemove | The header name | yes |
379
379
380
380
Config:
381
381
``` JSON
@@ -401,9 +401,9 @@ This removes the named header.
401
401
402
402
## RequestHeadersAllowed
403
403
404
- | Key | Value | Required |
405
- | -----| -------| ----------|
406
- | RequestHeadersAllowed | A semicolon separated list of allowed header names. | yes |
404
+ | Key | Value | Required |
405
+ | --------------------- | --------------------------------------------------- | -------- |
406
+ | RequestHeadersAllowed | A semicolon separated list of allowed header names. | yes |
407
407
408
408
Config:
409
409
``` JSON
@@ -436,14 +436,14 @@ Only header1 and header2 are copied to the proxy request.
436
436
437
437
** Adds headers with information about the original client request**
438
438
439
- | Key | Value | Default | Required |
440
- | -----| -------| ---------| ----------|
441
- | X-Forwarded | Default action (Set, Append, Remove, Off) to apply to all X-Forwarded-* listed below | Set | yes |
442
- | For | Action to apply to this header | * See X-Forwarded | no |
443
- | Proto | Action to apply to this header | * See X-Forwarded | no |
444
- | Host | Action to apply to this header | * See X-Forwarded | no |
445
- | Prefix | Action to apply to this header | * See X-Forwarded | no |
446
- | HeaderPrefix | The header name prefix | "X-Forwarded-" | no |
439
+ | Key | Value | Default | Required |
440
+ | ------------ | ------------------------------------------------------------------------------------ | ----------------- | -------- |
441
+ | X-Forwarded | Default action (Set, Append, Remove, Off) to apply to all X-Forwarded-* listed below | Set | yes |
442
+ | For | Action to apply to this header | * See X-Forwarded | no |
443
+ | Proto | Action to apply to this header | * See X-Forwarded | no |
444
+ | Host | Action to apply to this header | * See X-Forwarded | no |
445
+ | Prefix | Action to apply to this header | * See X-Forwarded | no |
446
+ | HeaderPrefix | The header name prefix | "X-Forwarded-" | no |
447
447
448
448
Action "Off" completely disables the transform.
449
449
@@ -513,12 +513,12 @@ The {Prefix}Prefix header value is taken from `HttpContext.Request.PathBase`. Th
513
513
514
514
** Adds a header with information about the original client request**
515
515
516
- | Key | Value | Default | Required |
517
- | -----| -------| ---------| ----------|
518
- | Forwarded | A comma separated list containing any of these values: for,by,proto,host | (none) | yes |
519
- | ForFormat | Random/RandomAndPort/RandomAndRandomPort/Unknown/UnknownAndPort/UnknownAndRandomPort/Ip/IpAndPort/IpAndRandomPort | Random | no |
520
- | ByFormat | Random/RandomAndPort/RandomAndRandomPort/Unknown/UnknownAndPort/UnknownAndRandomPort/Ip/IpAndPort/IpAndRandomPort | Random | no |
521
- | Action | Action to apply to this header (Set, Append, Remove, Off) | Set | no |
516
+ | Key | Value | Default | Required |
517
+ | --------- | ----------------------------------------------------------------------------------------------------------------- | ------- | -------- |
518
+ | Forwarded | A comma separated list containing any of these values: for,by,proto,host | (none) | yes |
519
+ | ForFormat | Random/RandomAndPort/RandomAndRandomPort/Unknown/UnknownAndPort/UnknownAndRandomPort/Ip/IpAndPort/IpAndRandomPort | Random | no |
520
+ | ByFormat | Random/RandomAndPort/RandomAndRandomPort/Unknown/UnknownAndPort/UnknownAndRandomPort/Ip/IpAndPort/IpAndRandomPort | Random | no |
521
+ | Action | Action to apply to this header (Set, Append, Remove, Off) | Set | no |
522
522
523
523
Config:
524
524
``` JSON
@@ -575,9 +575,9 @@ The RFC allows a [variety of formats](https://tools.ietf.org/html/rfc7239#sectio
575
575
576
576
** Forwards the client cert used on the inbound connection as a header to destination**
577
577
578
- | Key | Value | Required |
579
- | -----| -------| ---------- |
580
- | ClientCert | The header name | yes |
578
+ | Key | Value | Required |
579
+ | ---------- | --------------- | -------- |
580
+ | ClientCert | The header name | yes |
581
581
582
582
Config:
583
583
``` JSON
0 commit comments