REST Connect Release Notes - Mule 4

Support Category: Select

Guide: Convert an API specification to a Connector Using REST Connect

The REST Connect connector generator converts an API specification (RAML 1.0, OAS2, or OAS3) to a connector that you can use in a Mule application. For more information, see Convert an API specification to a Connector Using REST Connect.

1.15.5

February 6, 2024

What’s New

The REST Connect connector generator can generate Java 17-compatible connectors. See Upgrading a REST Connect Generated Connector.
Mule 4 connectors generated with REST Connect now support Transport Layer Security (TLS). See Generating Connectors With TLS Support.

1.12.5

Nov 6, 2020

Moved to the latest version (3.9.12) of Devkit for generating Mule 3 connectors.

Fixed issues

Fixed an issue in which defining the body of a request as an enum type provoked a failure to generate the Mule 3 version of the connector. (SE-17053)
Fixed an annotated parameter name bug. (SE-15190)

1.12.4

Oct 22, 2020

Moved to the latest version (4.3.1) of AMF (AML Modeling Framework).

Fixed issues

Operations now expose the attributes metadata.

1.12.3

Aug 19, 2020

Changed the metadata resolution mechanism.

1.12.2

Aug 13, 2020

Fixed Issues

Fixed the XXE vulnerability. (RESTC-935)

1.12.1

Jul 23, 2020

The HTTP dependency for smart connectors is updated to the latest version.

1.12.0

June 28, 2020

New Features

Added support for OAS3 specifications.

1.11.3

May 4, 2020

New Features

Moved to the latest AMF version (4.1.0-0)

Fixed Issues

Fixed annotated parameter name bug.
Fixed pluralization/singularization issues.

1.11.2

Apr 16, 2020

Fixed Issues

Upgraded outdated dependencies and solved vulnerabilities.

1.11.1

Apr 7, 2020

Fixed Issues

Upgraded outdated dependencies and solved vulnerabilities.

1.11.0

Apr 1, 2020

New Features

Allow users of the generated connector to define a custom response timeout.

1.10.18

Mar 19, 2020

Moved to the latest AMF version and adapted to its API changes that supports OAS3 API specs.

Fixed Issues

Support cases where an OAS specification does not define media type for a payload.(SE-14691)

1.10.17

Feb 28, 2020

Moved to the latest AMF version.

Fixed Issues

Now using AMF’s compact JSON Schema generation to avoid generating huge schema in some cases.

1.10.16

Feb 17, 2020

Fixed Issues

Fixed 'Billion Laughs' vulnerability.

1.10.15

Feb 12, 2020

Fixed Issues

Fixed a vulnerability in resource loaders.

1.10.14

Jan 31, 2020

Fixed Issues

Fixed XXE vulnerability (RESTC-857).

1.10.13

Dec 30, 2019

Fixed Issues

Added a parameter that allows customizing the DW expression used to renew the OAuth tokens (SE-14290)
Moved request streaming mode parameter to advanced tab (RESTC-833)
Fixed security scheme flow naming issue.

1.10.12

Dec 12, 2019

Moved to AMF latest version (4.0.3).

Fixed Issues

Optimized primitive type source generation.
Reduced JSONSchema generation.
Added support for base64 strings as primitive types.
Added support for all primitive types.

1.10.11

Oct 17, 2019

Fixed Issues

Removed legacy Java SDK code.
Log connector GAV when metadata fails to load.

1.10.10

Oct 17, 2019

Update AMF to its latest version.
Update RAML Parser to its latest version.

Fixed Issues

Changed all wire logging log level to debug (SE-13197).
Updated refresh token only for certain status codes (SE-13224).
Avoid generating huge JSON schemas that can break the extension model generation or make it take too long.

1.10.9

Sep 17, 2019

Fixed Issues

Allow user to decide which logs to show in the Mule app when using a DevKit connector (SE-13197).
Sanitize user input when generating DevKit connectors to avoid security risks (RESTC-770 & RESTC-771).
Fixed several errors that would not allow the user to generate a connector from a valid API spec (SE-12563, SE-13114, SE-12870 & SE-12852).

1.10.8

Aug 26, 2019

Update RAML Parser to its latest version.
Update AMF to its latest version.
Update generated smart connectors HTTP and OAUTH dependencies to its latest versions.

1.10.7

Aug 8, 2019

Fixed Issues

Sanitized DevKit connectors display names (SE-12525). OAuth tokens are not being refreshed in generated Smart Connectors (RESTC-714).

1.10.6

Jul 31, 2019

Fixed Issues

Skip parsing of RAML 0.8 specs when using RAMLParser because the format is not supported.
Default values should not get quotation marks (RESTC-682).
Fixed error with RAML specs that use singularize (RESTC-679).
Fixed XXE vulnerability (RESTC-734).

1.10.5

Jul 4, 2019

Fixed Issues

Trim Project Description in POM file to 250 characters (SE-12309).
Generate all declared UriParms for OAS specs (RESTC-707).

1.10.4

Jun 19, 2019

Fixed Issues

Use API displayName in operations for smart connectors (SE-11996).
Sanitize reserved parameter names for smart connectors (SE-11578).

1.10.3

Jun 7, 2019

Fixed Issues

This release fixes a bug.

1.10.2

Jun 6, 2019

Fixed Issues

This release fixes several bugs.

1.10.1

Feb 12, 2019

Fixed Issues

This release fixes a bug where the connector artifact was not being generated.

1.10.0

Feb 12, 2019

New Features

Using the latest AMF release (3.1.6)

Fixed Issues

Fixed maven-install-plugin compiling (RESTC-521).
Reduced generated elements as they are no longer needed (RESTC-521).
Fixed error messages for invalid specs/parsers.

1.9.4

Jan 28, 2019

Fixed Issues

This release solves performance issues of the generated Mule 4 connectors.

1.9.3

Jan 28, 2019

Fixed Issues

This release fixes several bugs.

1.9.2

Jan 17, 2019

Fixed Issues

Added support for sending arrays as query params (SE-10282).
Pass through security schemes are now generated properly for Smart Connectors (SE-10324).

1.9.1

Jan 17, 2019

Fixed Issues

This release fixes several bugs.

1.9.0

Nov 20, 2018

New Features

Added request streaming mode config for Mule 4 Connectors (RESTC-501).
Enhanced multipart support for Mule 3 and Mule 4 Connectors by annotations (RESTC-502).
Added default value support for enums (RESTC-504).
Enhanced sanitization for Java Strings (RESTC-376).
Added a better way of generating temporal JSON schema names.
Added supportability docs.
Added parallel testing for the CI environment in order to speed up builds.

Fixed Issues

Added a test case for this issue (SE-9268)
Fixed errors in multipart requests for Mule 3 (RESTC-502).
RAML 0.8 exception format is now the same for RAMLParser and AMF.

1.8.0

Oct 17, 2018

New Features

Specify a default mediaType annotation (RESTC-20).
Handle RAMLs that have parameters with similar names on the generation of Mule 3 connectors (RESTC-280).
Generate pojos correctly when using RAML Parser (RESTC-455 & RESTC-459).
Added support for ApiKey security schemes for OAS (RESTC-479).
Generate nicer and shorter operation names for OData specs (RESTC-480).
Sanitize GAV and string that could break the generated POM.
Added a POM check in order for Rest connect to fail when an invalid POM is generated.

Fixed Issues

Error generating connector: Multiple entries with same key (RESTC-298).
StackOverflowError with Square API in Mule 3 (RESTC-314).
Error generating Mule 3 Connector for New Relic API (RESTC-345).
Error validating examples for OData OAS spec (RESTC-421).
Default value for Enums causes Dev Kit Connector generation to fail (RESTC-458).
Avoid failing when generating schemas for operations that have long names (RESTC-480).
Rest Connect does not support assets with names with non-latin characters (RESTC-495).
OAuth grants not working when proxy is null (RESTC-507).
Escape paths (SE-9084).

1.7.0

August 24, 2018

This release incorporates the following improvements:

Uses the latest version of AMF (1.8.0)
Adds an annotation that lets users select which security scheme to use for an operation when creating a flow for Smart Connectors
Fixes DevKit connectors signature to work properly
Improves error messages when Rest Connect fails generating Mule 4 connectors
Exchange improvements: Moves error email management to the Rest Connect Service

Fixed Issues

Parameters defined for pass through or custom authentication schemes are now sent correctly
Fixed error that caused some generated smart connectors to not be able to be included in a project
Fixed some string sanitization issues

1.6.2

August 6, 2018

Fixed Issues

Types defined using XML Schemas work properly for Mule 4 Connectors

1.6.1

July 27, 2018

Fixed Issues

Types defined using XML Schemas work properly for Mule 4 Connectors

1.6.0

July 26, 2018

This release incorporates the following improvements:

Implemented conversion for OAS 2.0.
Updated to AMF Parser v1.7.1.
Supporting external files references for JSON and XSD schemas.
Supporting inner references for JSON and XSD schemas.

Fixed Issues

Set default base path when the RAML does not provide one.
Failing to generate a connector when the API defines a JSON schema using AMF.
Failing to resolve a type defined using a trait when using.
Failing with duplicated parameters.
Failing with elements with the same name within XSD Schemas.
Failing when using two security schemes of the same type.

1.5.0

June 28, 2018

This release adds support for OData Specs, Proxies, and Enums.

Fixed Issues

Fixed string sanitization issues.

1.4.1

May 29, 2018

This is a HotFix release.

Fixed Issues

Pass-through security scheme header did not work under certain conditions. (RESTC-410)

1.4.0

May 24, 2018

This release includes support for complex multipart requests containing parts with different types. Additionally, it now supports multilevel objects for sending form URL encoded requests.

Fixed Issues

Added new Resource Loader for AMF parser to support Exchange Modules.
Added support for array of arrays in DevKit connectors. (RESTC-405)
Added support for invalid base URIs. (RESTC-356)
Created JAR files correctly on Windows. (RESTC-330)
Encapsulated POJO generation errors.
Fixed error generating POJOs on Windows. (RESTC-392)
Fixed illegal argument exception. (RESTC-365)
Fixed StringOutOfRange exception.
Moved to AMF parser 1.3.3.
Moved to latest version of Java RAML parser. (RESTC-381)
Removed unused Manifest from Smart Connectors JAR.
Updated Extensions Maven Plugin version to fix packaging in Windows. (RESTC-393)

1.3.3

April 27, 2018

This is a HotFix release.

Fixed Issues

Fixed "scopes" parameter in Smart Connectors for OAuth2 Schemes without defined scopes.

1.3.2

April 17, 2018

This is a HotFix release.

Fixed Issues

Fixed Mule 3 Connectors with several security schemas not being generated.

1.3.1

April 17, 2018

This is a HotFix release.

Fixed Issues

Fix bug occurring when an OAuth2 scheme had scopes defined.
Performance improvement: Building Smart Connector merged security schema only once.

1.3.0

April 13, 2018

This release includes support for custom security schemes. Connectors will be generated based on security schemes defined in an API specification.

Fixed Issues

Fixed support for securedBy nodes.
Fixed several issues of Mule 3 connector generation with a proper string sanitization.

1.2.11

March 1, 2018

This release fixes a bug.

Fixed Issues

Fixed Pass-through authentication for Mule 3 connectors.

1.2.10

February 29, 2018

This release fixes a bug.

Fixed Issues

Fixed an issue to use the correct parameter name to make requests.

1.2.9

February 23, 2018

This release fixes a bug.

Fixed Issues

Avoid NPE when display name is not present in RAML.

1.2.8

February 23, 2018

This release fixes a bug.

Fixed Issues

Added support for Mule 4 Connectors to have a default output type.

1.2.7

February 6, 2018

This release fixes a bug.

Fixed Issues

REST Connect v1.2.7 now supports use with the Windows file system.

1.2.6

February 1, 2018

This release fixes a bug.

Fixed Issues

Using URL-encoded only inside Smart Connectors.

1.2.5

February 1, 2018

This release provides a bug fix.

Fixed Issues

Fixed the media type for a form URL-encoded use case.

1.2.4

January 30, 2018

This release provides a bug fix.

Fixed Issues

Removed unsupported modes for Basic Auth and Passthrough.

1.2.3

January 25, 2018

REST Connect v1.2.3 provides the following features:

Added Friendly Name support for operations and parameters by using the operationName and parameterName annotations on the rest-connect library.
Added support for OPTIONS and HEAD HTTP verbs.

Fixed Issues

Support for placeholders in the baseUri.
Improved error messages for duplicated operations or parameters.
Fixed outOfMemoryError when generating certain Mule 3 connectors.
Fixed error generating Mule3 connector when the RAML included a dot in its title.
Sanitized some property names that could break the build of Mule 3 connectors.

1.2.2

December 16, 2017

This release provides a bug fix.

Fixed Issues

REST Connect v1.2.2 now supports the PATCH method and properly sends the payload as a JSON rather than as a String.

1.2.1

December 16, 2017

Version 1.2.1 supports Java RAML Parser 1.0.16.

1.2.0

November 18, 2017

Version 1.2.0 supports the following security schemes defined in RAML v1.0:

OAuth2 - Authorization code
Digest authentication
Pass through

1.1.0

October 2, 2017

Version 1.1.0 supports creating Mule 3 connectors. When an API specification publishes to Exchange, REST Connect generates two connectors: one for Mule 4 and the other for Mule 3.

Version 1.1.0 - Fixes

REST Connect v1.1.0 now generates a connector properly whether a description is present or not. In REST Connect v1.0.0, if a description was not provided, REST Connector was unable to generate a connector properly.

1.0.0

July 28, 2017

Version 1.0.0 provides the following features:

Transforms a RAML 1.0 specification into a connector in Design Center.
Support for unauthorized requests, basic authentication, and OAuth2 (Client Credentials).
Support for query parameters, URI parameters, and headers as input attributes.
Support for metadata defined as RAML datatypes, XML schemas, or JSON schemas.
Inference of operation names given their parameters.

Known Issues

A RAML with the following type definition is not supported:

types:
  RecursiveType:
    type: object
    properties:
      aString:
        type: RecursiveType
        description: This modifies the reference and causes a stack overflow error.

No support for connectivity testing in the configuration for Design Center.
REST Connect doesn’t generate friendly names for input attributes.
Connector for Mule 3.x is not supported.
Custom SSL certificates are not supported.