LI81869: API PROPERTIES USED IN REQUIRED VALUES FIELDS CREATES VALIDATIONERRORS

APAR status

• Closed as program error.

Error description

• When trying to publish and validate an API that contains API
  properties used in the policy fields that have a set of
  required values, we get errors and the API is unable to be
  published.
  For example, when using the defined API properties in the
  policy activity-log below -
  swagger: '2.0'
  info:
    title: a1
    x-ibm-name: a1
    version: 1.0.0
  x-ibm-configuration:
    cors:
      enabled: true
    gateway: datapower-api-gateway
    type: rest
    phase: realized
    enforced: true
    testable: true
    assembly:
      execute:a
        - invoke:
            title: invoke
            version: 2.0.0
            verb: keep
            target-url: $(target-url)
        - activity-log:
            content: $(log_level)
            error-content: $(log_level_error)
            enabled: true
    properties:
      log_level:
        value: payload
        description: >-
          Logging level used in Analytics info for OK requests.
  Allowed values
          are: none, activity, headers, payload
        encoded: false
      log_level_error:
        value: payload
        description: >-
          "Logging level used in Analytics info for Error
  requests. Allowed values
          are: none, activity, headers, payload
        encoded: false
      target-url:
        value: 'https://jsonplaceholder.typicode.com/todos/2'
        description: The URL of the target service
        encoded: false
  basePath: /a1
  ....
  The back-end throws the following validation errors:
  1) content must be one of the following: "none", "activity",
  "header", "payload"
  2) error-content must be one of the following: "none",
  "activity", "header", "payload"
  Although the API property is set to the acceptable string
  value, "payload".
  To reproduce:
  1- deploy a v10 stack w/ reboot gateway
  2- configure the gateway, create a pOrg
  3- create a new API by uploading the reproduction yaml
  a1-1.0.0.txt (change extension to yml)
  4- at this point, you will see the validation errors stated
  earlier in this ticket for the API property values
  

Local fix

• Manually change
  error-content: $(log_level_error) - > error-content: 'payload'
  success-content: $(log_level) -> success-content: 'payload'
  

Problem summary

• Validation of API could break if API Properties are used as
  Property values in Policies inside Assembly. This was because
  the validation was being done before substituting API Property
  values.
  

Problem conclusion

• The product is updated to address the issue in 2018.4.1.15 and
  is currently targeted for addressing in 10.0.1.2.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  API CONNECT ENT

• Fixed component ID

  5725Z2201

Applicable component levels

• RA0X PSY

     UP