Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
Signed-off-by: Aurélien Pillevesse <[email protected]>
  • Loading branch information
AurelienPillevesse committed Nov 29, 2024
1 parent 7a34771 commit c9b1441
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions site/content/en/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,11 @@ BodyToExtAuth defines the Body to Ext Auth configuration
_Appears in:_
- [ExtAuth](#extauth)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `maxRequestBytes` | _integer_ | true | MaxRequestBytes is the maximum size of a message body that the filter will hold in memory.<br />Envoy will return HTTP 413 and will not initiate the authorization process when buffer<br />reaches the number set in this field.<br />Note that this setting will have precedence over failureModeAllow. |
| `allowPartialMessage` | _boolean_ | true | When AllowPartialMessage is true, Envoy will buffer the message until MaxRequestBytes is reached.<br />The authorization request will be dispatched and no 413 HTTP error will be returned by the filter. |
| `packAsBytes` | _boolean_ | true | If PackAsBytes is true, the body sent to the external authorization service is set with raw bytes,<br />it sets the raw_body field of HTTP request attribute context. Otherwise, body will be<br />filled with UTF-8 string request body.<br />This field only affects configurations using a grpcService. In configurations that use<br />an httpService, this has no effect. |


#### BootstrapType
Expand Down
5 changes: 5 additions & 0 deletions site/content/zh/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,11 @@ BodyToExtAuth defines the Body to Ext Auth configuration
_Appears in:_
- [ExtAuth](#extauth)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `maxRequestBytes` | _integer_ | true | MaxRequestBytes is the maximum size of a message body that the filter will hold in memory.<br />Envoy will return HTTP 413 and will not initiate the authorization process when buffer<br />reaches the number set in this field.<br />Note that this setting will have precedence over failureModeAllow. |
| `allowPartialMessage` | _boolean_ | true | When AllowPartialMessage is true, Envoy will buffer the message until MaxRequestBytes is reached.<br />The authorization request will be dispatched and no 413 HTTP error will be returned by the filter. |
| `packAsBytes` | _boolean_ | true | If PackAsBytes is true, the body sent to the external authorization service is set with raw bytes,<br />it sets the raw_body field of HTTP request attribute context. Otherwise, body will be<br />filled with UTF-8 string request body.<br />This field only affects configurations using a grpcService. In configurations that use<br />an httpService, this has no effect. |


#### BootstrapType
Expand Down

0 comments on commit c9b1441

Please sign in to comment.