@@ -26,9 +26,9 @@ The following are built in transforms identified by their primary config key. Th
2626
2727** Modifies the request path adding a prefix value**
2828
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 |
3232
3333Config:
3434``` JSON
@@ -50,9 +50,9 @@ This will prefix the request path with the given value.
5050
5151** Modifies the request path removing a prefix value**
5252
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 |
5656
5757Config:
5858``` JSON
@@ -75,9 +75,9 @@ This will remove the matching prefix from the request path. Matches are made on
7575
7676** Replaces the request path with the specified value**
7777
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 |
8181
8282Config:
8383``` JSON
@@ -99,9 +99,9 @@ This will set the request path with the given value.
9999
100100** Replaces the request path using a pattern template**
101101
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 |
105105
106106Config:
107107``` JSON
@@ -119,23 +119,23 @@ This will set the request path with the given value and replace any `{}` segment
119119
120120Example:
121121
122- | Step | Value |
123- | ------| -------|
122+ | Step | Value |
123+ | ---------------- | ----------------------------------- |
124124| 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 ` |
130130
131131## QueryValueParameter
132132
133133** Adds or replaces parameters in the request query string**
134134
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 |
139139
140140Config:
141141``` JSON
@@ -156,21 +156,21 @@ This will add a query string parameter with the name `foo` and sets it to the st
156156
157157Example:
158158
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 ` |
165165
166166## QueryRouteParameter
167167
168168** Adds or replaces a query string parameter with a value from the route configuration**
169169
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 |
174174
175175Config:
176176``` JSON
@@ -191,22 +191,22 @@ This will add a query string parameter with the name `foo` and sets it to the va
191191
192192Example:
193193
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 ` |
202202
203203## QueryRemoveParameter
204204
205205** Removes the specified parameter from the request query string**
206206
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 |
210210
211211Config:
212212``` JSON
@@ -224,20 +224,20 @@ This will remove a query string parameter with the name `foo` if present on the
224224
225225Example:
226226
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 ` |
232232
233233## HttpMethodChange
234234
235235** Changes the http method used in the request**
236236
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 |
241241
242242Config:
243243``` JSON
@@ -260,9 +260,9 @@ This will change PUT requests to POST.
260260
261261** Sets whether incoming request headers are copied to the outbound request**
262262
263- | Key | Value | Default | Required |
264- | -----| -------| ---------| ----------|
265- | RequestHeadersCopy | true/false | true | yes |
263+ | Key | Value | Default | Required |
264+ | ------------------ | ---------- | ------- | -------- |
265+ | RequestHeadersCopy | true/false | true | yes |
266266
267267Config:
268268``` JSON
@@ -282,9 +282,9 @@ This sets if all incoming request headers are copied to the proxy request. This
282282
283283** Specifies if the incoming request Host header should be copied to the proxy request**
284284
285- | Key | Value | Default | Required |
286- | -----| -------| ---------| ----------|
287- | RequestHeaderOriginalHost | true/false | false | yes |
285+ | Key | Value | Default | Required |
286+ | ------------------------- | ---------- | ------- | -------- |
287+ | RequestHeaderOriginalHost | true/false | false | yes |
288288
289289Config:
290290``` JSON
@@ -303,10 +303,10 @@ This specifies if the incoming request Host header should be copied to the proxy
303303
304304** Adds or replaces request headers**
305305
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 |
310310
311311Config:
312312``` JSON
@@ -335,10 +335,10 @@ Note: setting "" as a header value is not recommended and can cause an undefined
335335
336336** Adds or replaces a header with a value from the route configuration**
337337
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 |
342342
343343Config:
344344``` JSON
@@ -357,14 +357,14 @@ transformBuilderContext.AddRequestHeaderRouteValue(headerName: "MyHeader", route
357357
358358Example:
359359
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 ` |
365365| RequestHeaderFromRoute | ` foo ` |
366- | Append | ` remainder ` |
367- | Result | ` foo: more/stuff ` |
366+ | Append | ` remainder ` |
367+ | Result | ` foo: more/stuff ` |
368368
369369This 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.
370370Note: 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
373373
374374** Removes request headers**
375375
376- | Key | Value | Required |
377- | -----| -------| ----------|
378- | RequestHeaderRemove | The header name | yes |
376+ | Key | Value | Required |
377+ | ------------------- | --------------- | -------- |
378+ | RequestHeaderRemove | The header name | yes |
379379
380380Config:
381381``` JSON
@@ -401,9 +401,9 @@ This removes the named header.
401401
402402## RequestHeadersAllowed
403403
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 |
407407
408408Config:
409409``` JSON
@@ -436,14 +436,14 @@ Only header1 and header2 are copied to the proxy request.
436436
437437** Adds headers with information about the original client request**
438438
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 |
447447
448448Action "Off" completely disables the transform.
449449
@@ -513,12 +513,12 @@ The {Prefix}Prefix header value is taken from `HttpContext.Request.PathBase`. Th
513513
514514** Adds a header with information about the original client request**
515515
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 |
522522
523523Config:
524524``` JSON
@@ -575,9 +575,9 @@ The RFC allows a [variety of formats](https://tools.ietf.org/html/rfc7239#sectio
575575
576576** Forwards the client cert used on the inbound connection as a header to destination**
577577
578- | Key | Value | Required |
579- | -----| -------| ---------- |
580- | ClientCert | The header name | yes |
578+ | Key | Value | Required |
579+ | ---------- | --------------- | -------- |
580+ | ClientCert | The header name | yes |
581581
582582Config:
583583``` JSON
0 commit comments