Skip to content

Opensearch dashboards.routeconfigoptionsbody.parse

Home > opensearch-dashboards > RouteConfigOptionsBody > parse

RouteConfigOptionsBody.parse property

Determines if the incoming payload is processed or presented raw. Available values: * true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. * false - the raw payload is returned unmodified. * 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.

Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure.

Signature:

parse?: boolean | 'gunzip';