API properties

This property is supported only by the DataPower® Gateway (v5 compatible). If you are using the DataPower API Gateway then to achieve the same functionality add a header-control property to the invoke policy configuration in the OpenAPI definition for your API, as in the following examples.

- invoke:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- invoke:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

The default value is false.

The default value is false.

The default value is false.

The default value is false.

• all: Output all empty arrays, including empty children arrays. This is the default value if the property is not configured or has an invalid value.
• parent: Output only the current property's empty array value. Children map actions of this property are not attempted.
• none: Prevent any empty output array values from being produced.

The map policy builds a schema from an API definition when a referenced definition is provided as the value of the schema. If the schema does not have references that generate a circular reference, setting this property to true might provide a performance benefit while generating the same schema as would otherwise have been generated. However, in cases where the schema is very complex, with many potentially circular references, the generated schema could be different because the enhanced schema handling processes circular references differently. In such cases therefore, you should examine the resulting output to determine if the performance benefit gained is not at the expense of a change in the map policy output.

The default value of this property, is false, maintaining the existing behavior and performance.

The default value is false.

• string: The value for an empty XML element is considered to be an empty string. This is the default value if the property is not configured or has an invalid value.
• null: The value for an empty XML element is considered to be null. A mapping of this element to a JSON output property does not occur unless the API property x-ibm-gateway-map-null-value is also specified with a value of true.
• none: The empty XML element is ignored.
• string-badgerfish: The value for an empty XML element is considered to be an empty string. The empty string value will be placed into a JSON badgerfish value property.
• null-badgerfish: The value for an empty XML element is considered to be null. The null value will be placed into a JSON badgerfish value property. A mapping of this element to a JSON output property does not occur unless the API property x-ibm-gateway-map-null-value is also specified with a value of true.

The default value is 1, which means that circular schema definitions are not followed. The maximum possible value is 5. If you specify a value greater than 5, a value of 5 is assumed. If you specify a non-numeric value, a value of 1 is assumed.

• An array consists of objects that contain one or more required properties.
• An object which is optional has one or more child properties that are required.

By default, these required properties are not present in the output. If you set the x-ibm-gateway-map-emulate-v4-default-required-properties API property to true, these required properties will be present in the output. If the output schema defines a default property for the output property then the specified default value is used, otherwise a default value is assigned dependent on the data type, as follows:

• String: empty string ("")
• Number: 0
• Boolean: false
• Object: empty object
• Array: empty array

If the x-ibm-gateway-map-emulate-v4-default-required-properties API property is not specified or does not have a value of true, these required properties are not created in the output with their default values.

The default value is false.

This property is supported only by the DataPower Gateway (v5 compatible). If you are using the DataPower API Gateway then to achieve the same functionality add a header-control property to the invoke policy configuration in the OpenAPI definition for your API, as in the following examples.

- proxy:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- proxy:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

The default value is false.

The default value is true.

This property applies to the API request payload, and to the API response payload when x-ibm-gateway-api-enforce-response-limits is enabled.

• default: There is no inspection for these characters in the header values. If one is present, the API request fails with an HTTP 500 Internal Server Error.
• sanitize: Any illegal XML characters in header values are replaced with a ? character. The API processing will continue. Any API that attempts to read request.headers.<headername> will see the ? character in the value. However, the original protocol headers representing message.headers will still have the original character, which will be sent to an invoke or proxy backend server.
• bad-request: There will be an inspection for these characters in the header values. If one is present, the API request fails with an HTTP 400 Bad Request.

The default value is default.