Handling a call with unknown elements

A system API call may include a payload that includes a property that is not defined in the associated schema. By default, the system APIs reject unknown properties. You can override the default behavior by including the GW-UnknownPropertyHandling header. The header must be set to one of the following string values:

  • ignore - Ignore all unknown properties. Do not log any messages or return any validation errors.
  • log - Log a service-side info message, but then process the call, ignoring any unknown properties.
  • reject - Do not process the call. Return a validation error specifying there are unknown properties.

Similarly, a system API call may include a URL with a query parameter that is not defined in the associated schema. By default, the system APIs reject calls with unknown query parameters. You can override the default behavior by including the GW-UnknownQueryParamHandling header. The header must be set to one of the following string values:

  • ignore - Ignore all unknown query parameters. Do not log any messages or return any validation errors.
  • log - Log a service-side info message, but then process the call, ignoring any unknown query parameters.
  • reject - Do not process the call. Return a validation error specifying there are unknown query parameters.