API Connect

API Connect

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.


#API Connect
#Applicationintegration
#APIConnect
 View Only
Back to discussions
Expand all | Collapse all

JSON Schema for Validation IBM API Connect OpenAPI Extensions

  • 1.  JSON Schema for Validation IBM API Connect OpenAPI Extensions

    Posted 7 hours ago

    Is there a JSON schema to validate the IBM vendor extensions to the OpenAPI specifications?  I see one published for the API products: Product definition schema - IBM Documentation.  The reason I am asking is that sometimes developers use code editors like VS Code to make quick updates and produce invalid policy configurations that are not detected by the API Designer validate or by publishing the API product through the command line.

    Below is an example. The log policy has an invalid enumerated value for log-level: info. The API Designer does not flag this as an issue.  I would update my CI/CD process to perform a JSON schema validation to trap this issue before it becomes a run-time problem.

    Request:  Link to JSON schema for elements that are children of x-ibm-configuration.

    Example:

    x-ibm-configuration:
      cors:
        enabled: true
      gateway: datapower-api-gateway
      type: rest
      phase: realized
      enforced: true
      testable: true
      assembly:
        execute:
          - log:
              version: 2.1.0
              title: log
              log-level: info  //invalid
              mode: gather-only



    ------------------------------
    Steve Ruscik
    ------------------------------


Related Content