Restrictions On JSON

JSON files used to create REST services and references have some restrictions.

  • Arrays must have a homogeneous content.
  • Arrays cannot directly contain arrays ([[ ... ], [ ... ]])
  • Null type properties generate the XSD schema conversion error in TIBCO Business Studio for BusinessWorks. To create a REST Service or REST Binding, edit the input JSON file and change the data type from null to string.
  • If a Swagger 3.0 JSON file contains multiple server URLs, then on creating the REST service or a reference from it, the first URL is picked up to configure the shared resource's host and port. You can re-configure the host and port based on the server URL you want to invoke. Change the configurations accordingly in the shared resource.
  • If an operation in the Swagger 2.0 JSON file has parameters or responses with the embedded anonymous schema, by default a validation error occurs. In TIBCO Business Studio for BusinessWorks to turn off the validation error navigate to Preferences > BusinessWorks > Validation > Swagger with Anonymous schema and select the Warning or Ignore option.
  • If a Swagger JSON file has an optional array property with a minItems keyword, then it is treated as a required array property because it gets converted to an array element, which has an minOccurs attribute value set as per the minItems value.

  • Any property starting with the "xmlns" string in the Swagger JSON file must be avoided because, at runtime, this property does not take any effect.

Not currently supported

  • Binary content in JSON as a special case.
  • The Swagger 3.0 JSON file containing Open API 3.0 specific features, which are not in parity with the Swagger 2.0 JSON file.