Release Notes

The
Layer7 Live API Creator
Release Notes is a summary of new features, enhancements, fixes, and open issues for this release.
The
Layer7 Live API Creator
Release Notes summarizes new features, enhancements, a release comparison, fixes, known issues, and other important information specific to this release.
4
Release 5.4.1 (Patch) - October 2020
This fix addresses the following issues:
  • As of release 5.4.1,
    Layer7 Live API Creator
    collects and sends usage data by way of the Broadcom telemetry endpoint,
    https://telemetry.broadcom.com/loaddata
    , port 443. This endpoint replaces Segment and the Segment URL(US693662).
  • Layer7 Live API Creator
    connection to the external user database for managing TeamSpace users intermittently disconnects (DE468591).
For more information about how to download this patch, see Live API Creator Solutions and Patches on the Broadcom Support site.
Release 5.4 - May 2020
This release includes the following new features, enhancements, fixes, and known issues:
Migrate (or Upgrade) to
Layer7 Live API Creator
5.4
Migrate and Upgrade from Live API Creator 4.x or Earlier
If you are running Live API Creator 4.x or earlier, use the following process:
  1. Migrate the API definition that is in the admin database for Live API Creator 4.x and earlier to the admin repository that is in Live API Creator 5.0 using the migration service. This service is a utility that simplifies the process of migrating your APIs.
    For more information:
  2. Upgrade to this version of
    Layer7 Live API Creator
    .
    For more information about how to upgrade to this version of
    Layer7 Live API Creator
    , see Upgrade Live API Creator.
Upgrade from Live API Creator 5.x
If you are running Live API Creator 5.x, upgrade to the latest version of
Layer7 Live API Creator
.
If you are upgrading from Live API Creator 5.2 and you have defined your own data source provider, understand the changes in
Layer7 Live API Creator
5.3 regarding data source providers.
For more information about the changes regarding data source providers, see the 5.3 release notes.
For more information:
New Features and Enhancements
This section outlines the new marquee features and enhancements in this release.
To view feature and enhancement descriptions for previous Live API Creator releases, use the
Version
drop-down.
Improved Performance and Memory Stability
This release includes improvements to performance and memory utilization of API Server, particularly in areas where you have defined timers and listeners within your API.
Expanded Support for Java SE Development Kit 11
You can now run
Layer7 Live API Creator
using Java SE Development Kit (JDK) 11.
For more information about the versions of JDK that
Layer7 Live API Creator
supports, see Installation Requirements and Supported Platforms.
Pipeline Events
Pipeline events are JavaScript entry points to perform user-defined actions. The following enhancements have been made:
For more information about pipeline events, see Pipeline Events.
Event Handlers Are Now Pipeline Events
As of this release, the event handlers (request events, response events, and error events) have been deprecated. The pipeline events (request pipelines, response pipelines, and error pipelines) now replace the event handlers. For better developer experience when defining event processing actions in requests and responses, use pipeline events.
Your existing event handlers have been renamed in 5.4, and they continue to function in your API. For each of these existing event handlers, API Creator creates an issue recommending that you migrate to using pipeline events.
The following table shows the changes to the event type name:
Event type in previous releases
Event type name in 5.4
Event type replacement in 5.4
request (event handler)
requestDeprecated
requestPipeline (pipeline event)
response (event handler)
responseDeprecated
responsePipeline (pipeline event)
error (event handler)
errorDeprecated
errorPipeline (pipeline event)
Pipeline Events Pass In or Return Objects
Request pipelines pass in request payload objects as opposed to the JSON strings that request events returned. Response pipelines return result JavaScript objects as opposed to the JSON strings that response events returned. This change prevents loss of precision when dealing with large numbers (outside of the range and accuracy of JavaScript numbers).
Execute Pipeline Events using the PATCH Verb
You can now execute the event code for pipeline events by specifying the PATCH verb.
Other User Experience Improvements
This release includes the following user experience improvements:
Improved User Experience using JavaScript Objects
You can now send REST requests and access services, such as retrieving a resource or invoking another REST service, using the methods that are included with the new SysUtilityV2 object. This object includes the same methods as the SysUtility object, but unlike SysUtility, it always returns a JavaScript object. The new SysUtilityV2 object does not require that you parse JSON strings to JavaScript objects by including the JSON.parse() method. Including this method can lead to loss of precision when dealing with BigInteger and BigDecimal numbers.
For more information about the SysUtility object, see The SysUtility Object.
Updated Java Class and Context Variables
The TablePersistentBean Java class has been renamed to SQLPersistentBean. The SQLPersistentBean Java class supports the extensible data source framework. Ensure that you change references to the TablePersistentBean Java class in your existing JavaScript code to reference the SQLPersistentBean Java class.
For more information about extensibility, see Extensibility.
The containingRow JavaScript context variable has been renamed to parentTableRow.
For more information about this context variable, see Manage Resource Events.
JavaScript Code Runs in Strict Mode
The JavaScript code that you define in rules, resources, and functions now runs in JavaScript's strict mode. Strict mode improves JavaScript-code quality and allows the JavaScript engine in
Layer7 Live API Creator
to optimize the JavaScript-code processing during runtime.
For more information about strict mode and for best practices for changing your JavaScript code to work in strict mode, see the Strict mode tutorial on the MDN web docs site.
Visual Indicator for Rules
The rules editor now includes icons to the left of the rule in the list of rules that gives you a visual indicator of the various rule types.
For more information about these icons, see Rule Types.
Cluster Configuration
As of this release, to simplify the deployment of
Layer7 Live API Creator
within a cluster of nodes, listeners and timers now run across the cluster. You cannot configure Hazelcast to accommodate coordination (or synchronization) of listeners and timers across the cluster and have
Layer7 Live API Creator
execute timers or listeners for messaging support that rely on cluster synchronization.
Instead, to accommodate coordination (or synchronization) of listeners and timers across a cluster, define custom processing logic in your timer or listener code.
For more information:
Changes to the Single-User Demonstration Package
The single-user demonstration package of
Layer7 Live API Creator
that is based on Jetty (the demonstration package) now does not include the debug service (the debugger). This service required you to coordinate the breakpoints by starting two separate virtual machines (VMs) locally.
For more information about the demonstration package, see Install the Single-User Demonstration Package.
Updates to the Approaches to Creating APIs
The approaches to creating APIs in API Creator have been simplified to address the key
Layer7 Live API Creator
use cases. You can create APIs only using the
Database-first
and
Code-first
approaches. As of this release, you cannot:
  • Convert a data model, such as Swagger, to schema format, and then create your schema and API by importing your data model (the
    model-first
    approach).
  • Create an empty API, and then create a managed database within a managed data server (the
    app-first
    approach).
For more information:
Removal of Managed Data Servers
As of this release, you cannot add managed data servers and create a schema in
Layer7 Live API Creator
. You can continue to manage (add, update, and delete) tables, columns, and relationships for your existing data source connections and schemas. You can also continue to create tables and columns for data sources using Data Explorer. To create an API connecting to an existing database, create it using the
Database-first
approach, and then mark the data source as editable.
For more information:
Removal of the Data Source Support
Layer7 Live API Creator
now does not include the Salesforce data source (and the JDBC driver for Salesforce), the Apache Cassandra data source (and the Apache Cassandra JDBC driver), the Apache HBase data source (and the Apache HBase JDBC driver), and the CSV data source (and the CSV JDBC driver).
If you require connections to these data sources, define a data source provider that connects to these data sources. Data source providers are sets of JavaScript code that implement the extensible data source framework.
To set up connections to CSV/TSV Files data as a data source, you can use the example data source provider for CData CSV files on GitHub.
For more information about how to add a data source provider, see Manage Data Source Providers.
The Docker Container Uses a Tomcat Version that Does Not Enable AJP by Default
The Docker container includes Tomcat to run
Layer7 Live API Creator
. The Ghostcat vulnerability is a vulnerability found in certain versions of Apache Tomcat's AJP Connector that listens on port 8009. The version of Tomcat that the Docker container uses does not enable AJP by default.
For more information about this vulnerability, see CVE-2020-1938 on the Common Vulnerabilities and Exposures (CVE) site.
Release Comparison
This table compares the key features in recent releases of
Layer7 Live API Creator
:
Key Features
5.4
5.3
5.2
5.1
5.0
4.1
4.0
API Creation
App-first approach
Model-first approach
Database & Data Source Support
Salesforce data source
SAP NetWeaver data source
Apache HBase data source
CSV files as data source
Apache Cassandra data source
Messaging Capabilities
Time-Based Triggers
Developer Productivity
Debugger
Server Configuration & Management
* Data source that is created using the extensible data source framework
Fixed Issues
The following issue is fixed in this release:
  • DE439009 - Server performance degrades over time. This fix corrects several areas that caused the server to leak memory (timers and listeners) over time.
Known Issues
The following are known issues. Where available, workarounds are provided:
  • DE402883 - Because of a limitation included with the JDBC driver for Datacom, you cannot test the connection to Datacom data sources.
  • DE382731 - When
    Layer7 Live API Creator
    generates a log statement for a custom endpoint, the log shows the authentication token as
    CORS_Response Key:NA CORS_Response -2
    . These requests are normal unauthenticated requests and are not Cross-Origin Resource Sharing (CORS) requests.