Resource Bundle com.akana.console.policy.http.validation / HttpValidationPolicyApplicationResources Information

com.akana.console.policy.httpvalidation.OBVersion30.label

3.0 or earlier

com.akana.console.policy.httpvalidation.OBVersion31.label

3.1

com.akana.console.policy.httpvalidation.detail.title

HTTP Message Validation Policy Options

com.akana.console.policy.httpvalidation.help.paragraph

On this page you can configure use of the HTTP Message Validation Policy to validate HTTP messages based on criteria specified in the API definition document (Swagger, RAML, or WADL).Validation Scope identifies which messages in the message exchange should be validated by the policy: request messages, all responses, and/or fault responses.Processing Options: this section offers options relating to the message validation and reporting of detected errors:<ul><li>Fail Early: Provides the ability to reduce the overhead of message validation by terminating validation when the first error is encountered.</li><li>Enable format validation: Applies stricter validation by enabling the format JSON Schema keyword.</li><li>Verbose errors: Returns detailed validation error messages to the API client application.</li><li>Coerce strings: Treats strings as numeric, boolean, or null values as appropriate for validation purposes.</li><li>Exact decimals: Values with the same actual value but a different number of significant digits, such as 1.1 and 1.100, are not treated as equal.</li><li>Treat [null] as [ ]: Treats an array of null ([null]) the same as an empty array ([]). By strict JSON Schema rules, these two arrays are not equal.</li><li>UK Open Banking: To enforce compliance with the UK Open Banking specification, such as application/json content and specific headers, check the box and specify the version. For Version 3.1, you can provide a custom documentation URL for error messages.</li><li>Allow additional properties by default: If additionalProperties is not specified in a schema, any additional properties (not included in properties or patternProperties) will be allowed for that schema.</li><li>Ignore extra JSON in payload: If there are any items in the message payload after the initial JSON object, they will simply be ignored and will not return an error.</li><li>Allow all headers: To handle known bad headers, uncheck the box and specify the list of bad headers. Underneath the list of bad headers, specify whether the bad headers should be stripped from the message and allowed to continue or return an error if one is encountered. Please note that certain headers are vital to the HTTP message and should never be included in the list of unallowed headers.</li><li>Headers excluded from validation: List any headers that should be excluded from validation.</li></ul>

com.akana.console.policy.httpvalidation.help.title

Specify HTTP Message Validation Policy Options

com.akana.console.policy.httpvalidation.helpid

548

com.akana.console.policy.httpvalidation.modify.label

Modify

com.akana.console.policy.httpvalidation.modify.title

Modify HTTP Message Validation Policy

com.akana.console.policy.httpvalidation.option.OB.doc.url.label

Documentation URL

com.akana.console.policy.httpvalidation.option.OB.standard.help

Enable this option to have UK Open Banking formatted error messages returned to the API client application. By default, only a generic summary error message is returned. Note: The Gateway container log always contains all message validation error details.

com.akana.console.policy.httpvalidation.option.OB.standard.label

UK Open Banking

com.akana.console.policy.httpvalidation.option.OB.version.label

UK Open Banking Version

com.akana.console.policy.httpvalidation.option.allow.additional.properties.help

With this option enabled, if additionalProperties is not specified in a schema, any additional properties will be allowed for that schema. If disabled and additionalProperties is not specified in a schema, additional properties will not be allowed for that schema.

com.akana.console.policy.httpvalidation.option.allow.additional.properties.label

Allow additional properties by default

com.akana.console.policy.httpvalidation.option.allow.all.headers.help

With this option enabled, only headers defined in the schema for the calling operation will be checked. If disabled, options are shown for which headers to allow and what action should occur with headers not allowed.

com.akana.console.policy.httpvalidation.option.allow.all.headers.label

Allow all headers

com.akana.console.policy.httpvalidation.option.coerce.strings.help

With this option enabled, the policy treats strings as numeric, boolean, or null values as appropriate for validation purposes. For example, if a string looks like a number and the validation rules expect a number, the rule will pass. By default, all validation is applied to values exactly as they are presented.

com.akana.console.policy.httpvalidation.option.coerce.strings.label

Coerce strings

com.akana.console.policy.httpvalidation.option.enable.format.help

Enables the optional stricter validation specified by the format JSON Schema keyword. For example, the rules for date-time formats and for email addresses are strict. If not enabled, less strict validation is applied.

com.akana.console.policy.httpvalidation.option.enable.format.label

Enable 'format' validation

com.akana.console.policy.httpvalidation.option.exact.decimal.help

Enabling this option causes the number of significant digits to become a factor in the comparison of decimal numbers; values such as 1.1 and 1.100 are not considered equal. By default, these are treated as equal, based on value, without regard to trailing zeroes.

com.akana.console.policy.httpvalidation.option.exact.decimal.label

Exact decimals

com.akana.console.policy.httpvalidation.option.fail.early.help

With this option enabled, the policy stops processing the message after the first validation error. Otherwise, the policy continues to test all remaining validation rules and report any other errors in the message.

com.akana.console.policy.httpvalidation.option.fail.early.label

Fail early

com.akana.console.policy.httpvalidation.option.headers.excluded.from.validation.header

Headers

com.akana.console.policy.httpvalidation.option.headers.excluded.from.validation.help

Headers entered here that are defined in the calling operation's schema will not be validated.

com.akana.console.policy.httpvalidation.option.headers.excluded.from.validation.label

Headers excluded from validation

com.akana.console.policy.httpvalidation.option.headers.unallowed.header

Headers

com.akana.console.policy.httpvalidation.option.headers.unallowed.help

Enter all headers which should not be allowed.

com.akana.console.policy.httpvalidation.option.headers.unallowed.label

Headers not allowed

com.akana.console.policy.httpvalidation.option.ignore.extra.json.in.payload.help

With this option enabled, any extra JSON content after the initial JSON object in the payload will be ignored. If disabled, an error will be returned if any extra JSON is encountered after the initial JSON object in the payload.

com.akana.console.policy.httpvalidation.option.ignore.extra.json.in.payload.label

Ignore extra JSON in payload

com.akana.console.policy.httpvalidation.option.log.additional.properties.help

With this option enabled, an alert will be generated containing all additional properties in the request.

com.akana.console.policy.httpvalidation.option.log.additional.properties.label

Log additional properties

com.akana.console.policy.httpvalidation.option.null.array.help

With this option enabled, the policy treats an array of null ([null]) as an empty array ([]). By default, strict JSON Schema rules are applied, so these two arrays are not equal.

com.akana.console.policy.httpvalidation.option.null.array.label

Treat [null] as []

com.akana.console.policy.httpvalidation.option.strip.unallowed.headers.help

With this option enabled, headers that are not allowed will be stripped from the call and the remaining headers will be passed on. If disabled, an error will be thrown and the call will abort.

com.akana.console.policy.httpvalidation.option.strip.unallowed.headers.label

Strip unallowed headers

com.akana.console.policy.httpvalidation.option.verbose.errors.help

Enable this option to have detailed validation error messages returned to the API client application. By default, only a generic summary error message is returned. Note: The Gateway container log always contains all message validation error details.

com.akana.console.policy.httpvalidation.option.verbose.errors.label

Verbose errors

com.akana.console.policy.httpvalidation.processing.options.label

Processing Options

com.akana.console.policy.httpvalidation.validation.scope.fault

Fault

com.akana.console.policy.httpvalidation.validation.scope.help

Choose one or more options to specify which messages in an API call the policy will validate. Request validates input messages from client applications. Response validates output messages returned by the API endpoint.

com.akana.console.policy.httpvalidation.validation.scope.in

Request

com.akana.console.policy.httpvalidation.validation.scope.label

Validation Scope

com.akana.console.policy.httpvalidation.validation.scope.out

Response

com.akana.console.policy.httpvalidation.view.label

View

com.akana.console.policy.httpvalidation.view.title

View HTTP Message Validation Policy

error.modify.httpvalidation.policy.config

Error in modifying HTTP Message Validation policy: {0}