Restrictions on OpenAPI 3.0 documents

Consider the following limitations and restrictions when you use OpenAPI 3.0 REST APIs:

• You can import and implement OpenAPI 3.0 documents that contain external references, but you cannot edit these documents by using theIBM App Connect Enterprise Open API Editor.
• You can use the IBM App Connect Enterprise Toolkit to edit only one OpenAPI 3.0 document at a time.
• The base paths of all REST APIs deployed to a single integration server must be unique. You cannot deploy a REST API to an integration server if another REST API is deployed with the same base path.
• When the OpenAPI Editor is open, the REST API Editor is set to 'read only' mode. Only the Create, Edit,and Delete subflow buttons in the OpenAPI Editor are active.
• You can use OpenAPI 3.0 documents that contain multiple server objects, but the base URL in each object must be the same. You cannot use server templating, in which server variables are used to replace values in a URL template in the server object.
• Some aspects of the OpenAPI 3.0 specification are not currently supported by the user interface. In these circumstances, you can use the source view of the Open API editor to edit the specification text directly.
• The user interface does not currently support referencing a request body component from the request body of an operation. If you want to reference a request body component, add the reference to the request body of the operation directly in the OpenAPI source, as shown in the following example:

  requestBody: $ref: '#/components/requestBodies/request_body_component_name'

  The reference is confirmed on the details page for the request body in the user interface.
• Some OpenAPI 3.0 objects are ignored when you create REST API projects in App Connect Enterprise.
  • Cookie data parameters are allowed in OpenAPI 3.0 documents by IBM App Connect Enterprise, but no support is provided for parsing the HTTP Input header Cookie field into LocalEnvironment.REST.Input.Parameters.
  • Parameters of complex type are allowed in OpenAPI 3.0 documents, but IBM App Connect Enterprise does not currently support parsing or mapping complex type parameters.