SOAP-to-REST release notes

Summary

Version 1.7.18 introduces fixes for service discovery and the generation of example values in API specifications. Service discovery now correctly aggregates endpoints that use path parameters, and generated examples now conform to their defined schema constraints.

Fixes

This section details the fixes included in the v1.7.18 release.

Service Discovery Grouping for Path Parameters

Service discovery now correctly groups API calls with different path parameters into a single logical service.

Previously, requests made to endpoints with variable path parameters, such as /api/items/123 and /api/items/456, would result in the creation of separate, incomplete service entries. This behavior cluttered the service list and prevented traffic from being aggregated correctly for the logical endpoint.

With this fix, such requests are now correctly identified as belonging to the same service, ensuring a cleaner service list and accurate traffic aggregation.

Generated Specification Example Values

Example values included in generated API specifications now adhere to the constraints defined in their corresponding schemas.

Previously, generated examples might not have respected constraints such as maximum length, patterns, or enumerated values. This could produce invalid examples that would be rejected by API gateways or other validation tools. This fix ensures all generated examples are valid according to their schema definitions.

This release provides a fix for the syslog relay component.

Fixed

This release corrects an issue with the automatic disk expansion feature of the syslog relay.

• Syslog Relay Disk Expansion: The syslog relay will now automatically expand its disk storage when it begins to run low on space. This mechanism improves the reliability of traffic data collection by preventing interruptions or data loss that could occur if the disk became full.

Summary of Changes

Version 1.7.16 expands the functionality of the service examples feature and improves the reliability of data collection.

New Features

Expanded Transaction Examples

The "Examples" tab for a discovered service now generates representative transaction examples for a broader range of service types. Previously, this feature was limited to SOAP services.

With this update, examples are also generated for:

• RESTful services, including GET requests that do not have a message body.
• Services that use plain XML payloads.

This enhancement provides more comprehensive and useful examples for API publishers and consumers analyzing service traffic.

Fixes

Data Collection Reliability

This release resolves an issue where data collection could stop without warning if the system's disk became full. The system now includes automatic log file size management and will expand its disk capacity if necessary. This prevents service interruptions caused by disk space exhaustion and ensures more reliable operation.

Overview

Version 1.7.15 is a patch release that addresses a critical issue in the WSDL-to-mapping regeneration process. This fix ensures that API contracts derived from WSDLs with external schema imports are preserved correctly, preventing the accidental removal of validation rules.

Fixed

This release contains a fix for an issue where regenerating a mapping from a WSDL file could lead to the loss of data validation rules.

WSDL Regeneration Preserves Imported Schema Validations

Previously, when an API publisher regenerated a mapping from a WSDL file that used <import> to include type definitions from external schema files, the process could silently strip validation rules from the mapping. This affected rules such as string length, numeric ranges, and character patterns defined in the external schemas.

The consequences of this issue included:

• Incorrect Request Validation: Incoming requests might pass validation when they should have failed, potentially leading to errors in backend services.
• Activation Failure: The affected API version might fail to activate due to the inconsistent or incomplete contract.

This has been resolved. The regeneration process now correctly parses and preserves all type definitions and their associated validation rules from imported schemas.

Additionally, a new safeguard has been introduced. The system now prevents an existing mapping from being overwritten if the regenerated version is less detailed than the current one. This protects against the accidental degradation of an API contract during regeneration.

Summary

Version 1.7.14 is a patch release that resolves an issue with SOAP request generation. The fix ensures that XML payloads for services defined by certain WSDLs are generated correctly, preventing SOAP Fault errors from backend services.

Fixed Issues

This release contains the following fix:

Incorrect SOAP Request Namespace Prefixes

Previously, for some services defined by a WSDL, the platform would incorrectly add namespace prefixes to child elements within a generated SOAP request. This malformed XML payload would cause the backend SOAP service to reject the request and return a SOAP Fault.

This issue has been resolved. The system now generates the correct XML payload for these services, allowing them to be called successfully.

Upgrade and Migration

To benefit from this fix for services that were configured before this upgrade, you must take manual action.

Troubleshooting

Summary

Version 1.7.13 introduces a new feature for Log Search and resolves an issue with manual testing for SOAP APIs.

New Features

Log Search by Consumer IP Address

You can now search and filter API logs based on the originating IP address of the API consumer.

• The Log Search results table now includes a Consumer IP column.
• A new filter is available that allows you to find all requests from a specific IP address or a CIDR subnet.

Fixes

Manual SOAP API Testing

An issue has been resolved in the manual test feature for SOAP APIs. When providing JSON input containing large numbers, the platform no longer incorrectly converts them to scientific notation.

This release introduces a quality-of-life improvement for platform operators, making it easier to access release notes for the currently running platform version.

New Features

Release Notes Link for Current Version

A Release notes link is now available on the Current platform card, located on the Settings → Updates page in the user interface.

This feature allows platform operators to review the release notes for their currently installed and running version at any time. This is particularly useful for verifying features or changes associated with the current version, even when the system is fully up-to-date and no new updates are available.

To access the release notes for your current version:

1. Navigate to Settings.
2. Select the Updates page.
3. On the Current platform card, click the Release notes link.

This release streamlines the configuration of trusted proxies and resolves an issue with proxy hop resolution in Google Cloud Platform (GCP) environments.

Changes

• Streamlined Trusted Proxy Configuration: The system now automatically initializes the trusted proxy declaration in the background. This removes the need for API publishers to perform the manual "Enable broker" setup step. As a result, the setup banner clears automatically without user intervention.

Fixes

• GCP Trusted Proxy Hop Resolution: Resolved an issue where trusted proxy hops failed to resolve automatically on Google Cloud Platform (GCP) deployments if the load balancer flavor was not explicitly defined. Proxy hops now resolve automatically for all GCP deployment configurations.

This release provides a fix for an issue affecting the import of WSDL and XSD documents.

Fixed Issues

This section details the issues resolved in this release.

WSDL and XSD Import Failures due to Byte Order Mark

An issue was resolved where importing a WSDL or XSD document from a URL would fail.

• Symptom: The import process would terminate with a Content is not allowed in prolog error.
• Cause: This error occurred if the source file contained a UTF-8 Byte Order Mark (BOM). The presence of a BOM is common in files served by certain web servers, such as Microsoft IIS.
• Resolution: The import process now automatically detects and removes the UTF-8 BOM from WSDL and XSD files during import. This allows the service onboarding to complete successfully without requiring manual modification of the source files.

Summary

Version 1.7.9 is a maintenance release that addresses issues related to dashboard metrics and user interface stability.

Fixed Issues

This release includes the following fixes:

• Accurate Dashboard Metrics: Corrected an issue where the "Calls / day · discovered" card on the Operations Dashboard displayed an inflated count of discovered services. The calculation now correctly uses a 24-hour window, ensuring the metric accurately reflects the number of active discovered services.

• Table Sorting and Filtering Stability: Resolved an issue where table filters, such as checklist and condition filters, were unstable.

Overview

Version 1.7.8 introduces new security controls, simplifies network configuration, and resolves an issue with SOAP testing visibility. Key changes include the ability to define IP-based access restrictions on a per-service basis and the automation of trusted proxy configuration, which removes a manual setup step.

New Features

Per-Service IP Address Access Control

API publishers can now configure access controls for individual services based on the caller's source IP address. During the service onboarding flow or from the individual service settings page, you can define a list of allowed source IP addresses. Alternatively, you can configure the service to be "open, no limit," which does not restrict access by IP.

Changes and Improvements

Automated Trusted Proxy Configuration

The platform now automatically detects and configures trusted proxies based on the deployment's infrastructure topology. This enhancement removes the need for manual configuration of trusted proxies in the global settings menu. A primary benefit of this change is the prevention of connection rejections that could previously occur in development environments due to misconfiguration.

Fixes

Manual SOAP Test Payload Visibility

This release corrects an issue in the Manual SOAP Test feature. Previously, when using JSON input for a manual SOAP test, the "SOAP Request Sent" tile in the user interface was disabled and marked as "Not available," even on successful requests.

The tile is now correctly enabled and clickable for all outcomes, including successful runs and SOAP faults. This allows API publishers to inspect the exact generated SOAP envelope that was sent, which aids in troubleshooting and validating the transformation from JSON to SOAP.

Summary

Version 1.7.7 introduces a new SOAP Broker mode for handling legacy SOAP integrations and an associated access control mechanism based on consumer IP addresses.

New Features

This release adds the following capabilities.

SOAP Broker Mode

A new "SOAP Broker" mode is now available. This mode provides transparent, byte-faithful SOAP-to-SOAP passthrough. It is designed for legacy integrations where preserving the integrity of the original XML payload is critical.

SOAP Broker Access Control

To secure services operating in SOAP Broker mode, this release adds IP-as-credential access control. API publishers can create grants that restrict service access to a list of authorized API consumer IP addresses.

This release improves the reliability and functionality of the "Bulk Apply" feature for HTTP profiles.

Feature Enhancements

Bulk Apply for HTTP Profiles

The "Bulk Apply" feature, used for assigning HTTP profiles to multiple virtual servers, has been updated to be more powerful and reliable.

The key changes are:

• Handling of Existing Profiles: Previously, attempting to apply an HTTP profile to a virtual server that already had one would cause an error. The feature will now automatically replace any existing HTTP profiles on the target virtual servers.

• Batch Processing on Failure: Previously, a failure on a single virtual server could halt the entire batch operation. Now, if an update for a single server fails, the process will continue with the remaining servers in the batch.

• Detailed Reporting: After the operation completes, the system now provides a detailed summary report. This report includes a list of successes, failures, and any items that were skipped.

This document provides the release notes for version 1.7.5 of the s2r platform.

Summary of Changes

This release introduces a quality-of-life improvement for managing F5 virtual servers by allowing bulk role assignment. It also includes a fix to ensure that multiple selected virtual servers are correctly added to the discovery scope when saved.

New Features

Bulk Role Assignment for F5 Discovery

On the F5 Discovery settings page, API publishers can now assign a role to multiple virtual servers simultaneously. This feature streamlines the configuration of large numbers of servers.

To use this feature:

1. Navigate to the F5 Discovery settings page.
2. Select the checkboxes for the desired virtual servers.
3. Open the Bulk Apply menu.
4. Choose the Set role option.
5. Assign one of the following roles:
   • Frontend
   • Backend
   • Remove from scope (by selecting the option to remove)

Fixes

F5 Discovery Scope Saving

Previously, when an operator selected multiple virtual servers on the F5 Discovery settings page and clicked Save Scope, the selected servers were not added to the discovery scope. This issue has been resolved. Now, any servers selected in the UI are correctly added to the scope upon saving.

This document provides the release notes for version 1.7.4.

Added

• Service Inventory Traffic Summary: The Service Inventory table on the Discovery page now features a summary row at the bottom. This row displays the total number of observed API calls across all services for the 24-hour, 7-day, and 1-month time periods, providing an at-a-glance view of total API traffic volume.

Changed

• The Ingest VM health status

This release introduces more detailed information for available product updates, improves the accuracy of update status reporting, and corrects the behavior of the Manual SOAP Test during API onboarding.

New Features

Enhanced Update Information

The Available update card on the Settings > Updates page now provides more context for new product versions before installation. The card displays the following additional information:

• Severity: The severity level of the update.
• Summary: A brief summary of the changes in the update.
• Release Notes Link: A direct link to the release notes for the new version.

This allows administrators to better assess the impact and importance of an update before applying it.

Changes and Improvements

Accurate Update Status Reporting

The update status check on the Settings > Updates page now provides more precise feedback. Previously, if an update check failed (for example, due to a network issue), the UI could incorrectly display an "Up to date" status.

With this change, the UI will now report the specific reason why the update check could not be completed, ensuring administrators have an accurate understanding of the system's update status.

Fixes

Correct SOAP Fault Handling in Manual Tests

During API onboarding, the Manual SOAP Test will now correctly report a failure when a backend service responds with a SOAP Fault message. In previous versions, tests that received a SOAP Fault could be incorrectly marked as successful. This fix prevents misconfigured APIs from appearing to be functional during the onboarding process, ensuring that only correctly configured backend services pass the test.

Overview

Version 1.7.2 introduces user interface enhancements to the administration console and resolves a critical issue related to system updates. The changes improve usability on wide-screen displays by increasing the maximum page width and rebalancing column sizes on the Services page. This release also fixes a silent failure mode where the system would not apply updates while incorrectly reporting that it was up to date.

Changes

This release includes the following enhancements to the administration console user interface:

• Increased Page Width: The maximum width of pages has been increased. This change makes better use of available screen space on wide monitors, providing more room for content within tables.
• Improved Services Page Layout: On the Services page, the column widths have been adjusted to improve readability. Specifically, the Service URL Name and Display Name columns are now wider to reduce text truncation, making it easier to identify services.

Fixes

This release resolves a significant issue with the system update process:

• Update Status Reporting: Previously, the system could fail to apply an update, but the administration console would incorrectly report the status as "Up to date". This issue has been fixed. The console will now accurately reflect when an update check fails. The underlying cause of these silent update failures has also been resolved to ensure updates are applied correctly.

Summary

Version 1.7.1 introduces significant usability enhancements to tables within the administration interface. This release adds advanced, Excel-style column filtering and allows for personalizing table layouts by reordering and resizing columns. Additionally, all tables have been updated to be fully responsive, improving the user experience on various screen sizes.

New Features

Advanced Column Filtering

Tables throughout the administration interface now support advanced filtering capabilities. To access these filters, right-click a column header to open a popover menu.

The filtering options include:

• Value-based filtering: Search for and select specific values from a list, including an option to filter for blank entries.
• Condition-based filtering: Apply type-aware conditions. Supported conditions include text, number, and date range filters, such as "Between".

Customizable Table Columns

Users can now customize the layout of tables to suit their preferences. The following customizations are available:

• Column Resizing: Drag a column header's edge to resize its width.
• Column Reordering: Drag and drop a column header to a new position.

These layout preferences are saved automatically for each table. A "Reset" option is available to restore the table to its default column layout.

Changes and Improvements

Improved Table Layouts

All administration tables have been upgraded to be fully responsive. Tables now automatically adjust their width to fit the screen, which prevents horizontal scrolling. To maintain a clean layout, long text content, such as URLs or file paths, is now truncated with ellipses.

Overview

Version 1.7.0 introduces new capabilities for controlling error responses and customizing behavior at the operation level.

Key additions in this release include:

• SOAP Fault Detail Exposure Control: A new global configuration setting allows API publishers to control the level of detail returned to API consumers when a backend SOAP Fault occurs. This helps prevent the exposure of potentially sensitive backend information.
• Per-Operation Conversion Overrides: It is now possible to define conversion overrides for individual operations.

New Features

This section details the features added in version 1.7.0.

Control SOAP Fault Detail Exposure

To prevent leaking potentially sensitive information, such as backend stack traces, API publishers can now control the level of detail exposed to API consumers when a backend service returns a SOAP Fault.

This is managed by a new global setting that supports two modes:

• safe: This is the default mode. It strips potentially sensitive details from the SOAP Fault before returning the error response to the client.
• full: This mode returns the complete, unmodified SOAP Fault from the backend. It is intended for debugging purposes.

Configuration

Per-Operation Conversion Overrides

Version 1.7.0 adds the ability for API publishers to define conversion overrides on a per-operation basis using the operation editor.

Summary

Version v1.6.21 addresses issues related to the platform's update mechanisms. This release improves the reliability of tracking product update history and ensures that automated system service updates execute correctly.

Fixes

This release contains the following fixes:

• Update History Status: Resolved an issue where product update records could indefinitely remain in an "in progress" state. The system's update operations now track each attempt individually, ensuring the update history accurately reflects the final outcome, such as success, failure, or rollback.
• Automated System Service Updates: Fixed a problem where background management services were unable to discover and apply system self-updates. This was caused by mismatches in update channel and versioning data. Automated updates now execute in the background without requiring manual intervention.

Overview

Version 1.6.20 introduces enhanced control over the software update process, particularly for deployments requiring manual approval. Administrators can now review and apply available updates on-demand. This release also improves the visibility of the current update status and fixes an authentication issue related to manual update requests.

New Features

Manual Software Update Control

For deployments configured with a manual approval mode, an "Apply Update" option is now available in the settings interface. This feature allows administrators to:

• Review available software releases before installation.
• Trigger the update process at a time of their choosing.

This change gives administrators direct control over the update lifecycle, ensuring that updates are only applied after explicit confirmation.

Enhanced Update Status Display

The software update status display has been improved to provide more context. It now shows:

• The latest available product version.
• The currently configured update mode (automatic or manual).
• The configured interval for checking for new updates.

Changes

Update Mode Enforcement

The behavior of different update modes is now more strictly enforced:

• Manual / Operator Approval Mode: Deployments configured for manual approval will now detect and display available updates but will not install them automatically. Installation only proceeds when an administrator uses the "Apply Update" option.
• Automatic Mode: This mode's behavior is unchanged. It continues to install updates as soon as they become available.

Fixes

This release corrects an issue with request authentication signatures. This bug previously prevented manual update requests, initiated by an administrator, from being processed successfully. With this fix, the "Apply Update" feature functions as intended.

This document provides the release notes for version 1.6.19.

Changes in This Release

This release introduces an improvement to the update check mechanism and clarifies user interface text.

On-Demand Update Checks

The behavior of the Check now button in the Settings > Updates menu has been changed. Previously, clicking this button would refresh the view with cached data. Now, it immediately initiates a live, on-demand check for both software and topology updates, retrieving the latest available status directly from the update source.

UI Text Improvements

The inline documentation and help text within the Settings menu have been updated for improved clarity.

Version 1.6.18 introduces enhancements to the automated update check mechanism and the user onboarding experience, along with important bug and security fixes.

Changes

This release includes the following enhancements and behavioral changes.

Automated Update Check Preferences

Automated update checks now correctly honor the preferences configured by the API publisher. The system will respect the settings for:

• Update channel
• Update mode
• Update check frequency

Onboarding UI Improvement

To streamline the initial setup process for new users, the Conversion Overrides panel within Step 3 of the onboarding workflow is now collapsed by default. API publishers can still expand this panel to access its settings when needed.

Fixes

This release addresses the following issues.

UI and Display Fixes

• A rendering issue during onboarding has been fixed. Previously, opening the version update menu would cause it to appear behind the main navigation ribbon, obscuring it from view.

Security Fixes

• A security vulnerability on the update settings page has been resolved. The system now validates all release note links to ensure they are not malicious, preventing the potential for script execution.

Summary

Version 1.6.17 is a patch release that addresses a bug affecting the display of software updates.

Fixed Issues

This release resolves an issue where the Settings > Updates page could incorrectly display a false error banner and an empty list of available updates.

• Symptom: Users would see an error message stating "A received update was rejected because its signature didn't verify" and the list of available updates would be empty, even when updates were available.
• Resolution: The system now correctly verifies update availability and status. The Settings > Updates page accurately reflects the system's release state without displaying erroneous signature verification errors.

This release introduces a new background observation capability and includes important fixes for the automatic update mechanism and security vulnerabilities in underlying dependencies.

New Features

• Background Network Topology Observation: This version enables the platform to observe network topology in the background. This process is secured using embedded cryptographic key verification.

Fixes and Improvements

• Automatic Update Validation: A signature verification issue has been resolved. This issue previously prevented automatic background updates from being correctly validated and applied.
• Dependency Security: Addressed security vulnerabilities within underlying software dependencies. These fixes mitigate potential risks, including privilege escalation and denial-of-service (DoS) attacks.

Breaking Changes

There are no breaking changes in this release.

Version 1.6.15 is a maintenance release that improves the system's update mechanism and corrects an issue with version reporting. This release focuses on operational stability by ensuring that deployments can accurately detect new releases and that system status reports reflect the true installed version.

Improvements

• Enhanced Product Update Accuracy: The system update check, located under Settings > Updates, now automatically resolves the correct update channel assigned to the deployment. This ensures that newly published releases for the assigned channel are reliably detected.

• Improved Update Detection with Unknown Version: If the system is unable to determine its currently installed version during an update check, the updates panel will now display an alert that an update may be available. Previously, this scenario could cause the system to incorrectly report that it was up to date.

Fixes

• Accurate System Version Reporting: System status views and health reports now consistently display the correct release version number. This resolves an issue where a generic development placeholder was sometimes shown instead of the true version.

Breaking Changes

The source does not indicate any breaking changes in this release.

Upgrade Instructions

The source does not specify any special migration steps for this version. The standard update process applies.

Summary

Version 1.6.14 introduces automatic health heartbeats for improved operational visibility of self-identified deployments. It also simplifies deployment management by standardizing on a single container image per version, with configuration now resolved dynamically from the central platform.

Added

Automatic Deployment Heartbeats

Self-identified installations now automatically transmit health heartbeats to the central management platform. This provides API publishers with continuous visibility into the connectivity and operational status of their deployed agents. This feature addresses the need for real-time health monitoring.

Changed

Unified Deployment Container Images

Release deployments have been standardized to use a single container image per version. Previously, different deployment configurations may have required specialized image variants or local environment configuration.

With this change, all deployment-specific configuration is resolved dynamically by the agent at runtime via the central management platform. This eliminates the need for API publishers to build or maintain multiple container images.

Fixed

Deployment Status Visibility

This release fixes an issue where self-identified installations failed to report telemetry to the platform. This failure prevented the "last seen" timestamps and the online connectivity status from updating correctly in the management interface. The fix ensures that the status of all deployments is accurately reflected.

This document provides the release notes for version 1.6.13.

Added

Automated Topology Reconciliation

The release controller can now automatically fetch, verify, and apply system network topology configurations. This feature synchronizes load balancer path rules and access controls with their desired state, reducing manual configuration management.

Built-in Update Verification Keys

Release verification keys are now pre-packaged within the release controller. This change eliminates the need for manual key provisioning during the deployment setup process.

Changed

Accurate Release Controller Status Reporting

The status reporting mechanism on the Settings page has been updated. A release controller that is operating correctly but has self-updates disabled will now accurately reflect a healthy operational status, instead of incorrectly displaying a degraded state.

Fixed

Settings Panel UI Formatting

This release restores the proper layout, spacing, and typography for key-value labels and details within the Updates and License tabs of the Settings panel.

Overview

Version 1.6.12 introduces enhancements to license visibility, streamlines the license management interface, and improves the reliability of automated updates and system status checks.

Enhancements

• Expanded License Details: The License settings page now displays the deployment type and the assigned update channel in addition to the active license information.

Changes

• Streamlined License Interface: The License settings page has been updated to align with automated license delivery. Obsolete steps for manual license requests have been removed. The "Issued to" field now displays the recipient's email address.
• Internal Release Channel Support: The system now correctly performs update checks and tracks status when subscribed to the internal update channel. This ensures that system update status is accurately reported in the management console.
• Automated Service Status Discovery: System status checks for update-related components are now dynamically routed through an internal load balancer. This change removes the requirement for hardcoded status configuration settings.

Fixes

• Automatic License Identity Reconciliation: A fix has been implemented to resolve an issue where mismatched deployment identity records could lead to repeated license validation failures during automated background updates.
• Missing License Information: An issue has been resolved where the "Issued to" field on the License summary card would appear blank when displaying an active license.

Summary

Version 1.6.11 focuses on improving the administrative experience for software updates and license management. This release introduces automatic notifications for background updates, provides more detailed license status information, and streamlines the user interface for both updates and offline license activation. Key fixes address issues with deployment ID consistency and extraneous log errors.

New Features

Automatic Update Notifications

System updates that complete in the background are now recorded in the update history. This change also triggers administrative notifications, providing administrators with full visibility into all software updates as they occur.

Expanded License Details

The license settings page has been enhanced to display additional status indicators. These new indicators include the current offline operation status and the number of remaining days in any applicable grace period.

Changes and Improvements

Reorganized License and Update Settings

To create a more intuitive administrative workflow, several controls and information points have been relocated:

• Deployment ID: This information is now located on the License page instead of the Updates page.
• Offline License Management: Controls for managing offline licenses have also been moved from the Updates page to the License page.

Streamlined Updates Interface

The platform updates summary view has been simplified for clarity. Redundant "channel" and "mode" entries have been removed. The interface now provides clearer status messages when the system is checking for available updates.

Simplified Offline License Activation

The workflow for offline license activation has been updated to prioritize direct token input. This change is designed to make the activation process easier for deployments in air-gapped or network-restricted environments.

Fixes

Unified Deployment Identification

This release resolves an issue where background management services and application endpoints could generate mismatched deployment identifiers. This fix prevents license validation failures and incorrect reports of offline status that were caused by the identifier mismatch.

Extraneous Log Errors

An obsolete background update check that was generating redundant HTTP 404 error entries in application logs has been removed. This change reduces log noise and eliminates misleading error messages.

Summary

Version 1.6.10 improves security by changing how mTLS certificates are stored and resolves a bug that prevented the import of WSDL definitions.

Changes

Enhanced mTLS Certificate Security

Product mTLS security certificates are now embedded directly into the service binaries. Previously, certificates were stored as standalone files within deployment images. This change improves the protection of the underlying authentication credentials.

Fixes

WSDL Import Failures

This release resolves an issue where importing WSDL (Web Services Definition Language) definitions would fail. The failure was caused by errors during XML transformation and parsing.

This release enhances the security and reliability of the software update delivery mechanism.

Summary of Changes

This version introduces the use of dedicated authentication certificates for each product when publishing software updates. This change isolates the update process per product, strengthening the integrity and verification of delivered software releases. No action is required to enable this feature.

Changes in This Release

Changed

• Software release updates are now published using dedicated, per-product authentication certificates. This improves the security and reliability of the update delivery process.

These are the release notes for version 1.6.7.

Summary of Changes

This release introduces new capabilities for on-demand service health testing and expands support for service discovery from a wider range of traffic sources.

Added

This section details the new features introduced in this release.

Manual and Automated Conversion Replay

This release adds a mechanism to test the round-trip conversion health for individual services. This can be triggered in two ways:

• Manual Trigger: A new button in the Services management console allows API publishers to initiate a health check for a service on demand.
• Automated Schedule: Health checks are now run automatically on a nightly schedule to ensure that service health indicators remain up to date.

Vendor-Agnostic Service Discovery

Service, consumer, and topology discovery capabilities have been expanded to support traffic sources beyond F5. The platform can now discover endpoints and learn schema fields from the following sources:

• Citrix
• HAProxy
• NGINX

This release provides fixes for WSDL parsing, traffic log viewing, and service deletion.

Fixed Issues

This release resolves the following issues:

• WSDL Schema Resolution on HTTP Redirects: WSDL documents that import schemas from URLs are now processed correctly when the server issues an HTTP redirect. The platform now resolves relative XML schema import paths against the final destination URL after the redirect, which prevents WSDL parsing failures.

• Traffic Log Detail Display: An issue causing an HTTP 500 server error when viewing the details of a traffic log entry has been resolved. This error occurred specifically for transactions that contained request or response headers.

• Service Deletion Stability: Resolved a condition where deleting services with a large volume of associated historical traffic logs could lead to database deadlocks, timeouts, or system lock contention. The deletion process is now more stable and resilient under these circumstances.

Overview

Version 1.6.5 introduces a significant simplification for deployments on Google Cloud Platform, enhances the performance of the Operations Dashboard, and resolves a key API error. This release focuses on improving operational efficiency and user experience.

New Features

Automatic Deployment Configuration on Google Cloud Platform

System deployments on Google Cloud Platform (GCP) are now automated to detect key configuration details from the environment. This eliminates the need for operators to manually configure certain environment variables.

The system automatically detects the following:

• Environment project details
• Region
• Service templates
• Active product versions

This change streamlines the deployment process and reduces the potential for configuration errors on GCP.

Enhancements

Operations Dashboard Load Performance

This version includes a significant performance improvement for the Operations Dashboard. Load times have been reduced by optimizing how F5 summary data is handled. The system now retrieves and processes this data more efficiently in the background, resulting in a faster experience for operators monitoring the system.

Resolved Issues

Service List API Error

A bug has been fixed that caused an HTTP 406 error when listing services. This error occurred in both administration views and when using management endpoints. API consumers and administrators will no longer encounter this error when retrieving the service list.

Overview

Version 1.6.4 is a maintenance release that introduces new deployment flexibility, improves API consistency, hardens security for production environments, and resolves an authentication issue with system update checks.

Added

Customizable Relay Container Images

Relay deployment scripts now support specifying custom container image references. This allows API publishers to use images from private or alternative container registries instead of the default public registry. This customization is configured through environment variables.

Changed

Unified License Status Reporting

The API response fields for reporting system license status have been standardized. Previously disparate fields are now consolidated into a single, consistent property across all relevant API responses. This change simplifies the process for API consumers to programmatically track the system's license state.

Production Security Hardening

To provide a more secure initial installation, several development-only and legacy components have been removed from the platform. The following items are no longer included in a default deployment:

• Development-only authentication overrides
• Unused background schedulers
• Legacy default seed accounts

Fixed

System Update Authentication Failures

This release corrects an issue where background checks for system updates would fail with authorization errors. The underlying problem was related to stale credentials used during the polling process.

The fix implements a mechanism to automatically rotate and refresh the dynamic credentials used for these checks, ensuring that the update polling process remains authenticated and can successfully retrieve system update information.

Version 1.6.3 introduces significant enhancements to licensing, dynamic configuration, and authentication. Key changes include automatic administrator account provisioning, configurable license enforcement policies, and the replacement of static tokens with certificate-based authentication for product updates.

Added Features

Tenant Administrator Bootstrapping

Upon license activation, the platform now automatically provisions the primary administrator account for a new tenant. This allows an administrator to gain immediate access to the system to begin tenant setup and management without manual intervention.

Flexible License Enforcement Modes

This version introduces configurable license enforcement policies. One of the new options is a runtime stop policy, which will halt all service processing if the system detects that a valid license is expired or missing past its grace period. This provides a stricter enforcement mechanism for license compliance.

Changed Features

Certificate-Based Update Authentication

The mechanism for authenticating product update checks has been changed. The system now uses mutual TLS (mTLS) with client certificates and unique deployment identifiers for authentication. This change removes the previous requirement for API publishers to configure and manage static update registry tokens.

Dynamic Capacity Limit Metering

Capacity metering is now more dynamic. The system reads usage limits directly from the capabilities defined in the active license file. This allows for custom enforcement thresholds to be applied without requiring a product upgrade or restart.

License-Driven Capabilities

System functionality is now enabled dynamically at runtime based on the capabilities granted by the active license. This change removes the need to configure functionality using deployment environment flags, centralizing feature management within the license itself.

# Version 1.6.2

## Overview

Version 1.6.2 simplifies the integration of platform services by standardizing how they communicate. This release focuses on the product feedback and built-in AI Assistant features, removing the need for manual network configuration to enable them. The goal is to provide more secure and reliable communication for these services out of the box.

## Changes in this release

### Changed

*   The service integrations for the **product feedback** feature and the **built-in AI Assistant** have been standardized. This change ensures secure and reliable communication for these services without requiring manual network configuration.

## Upgrade Impact

After upgrading to version 1.6.2, any manual network configurations previously required for the product feedback and AI Assistant integrations are no longer necessary. The platform now manages these connections automatically. API publishers should remove any previous configurations to avoid potential conflicts and rely on the new standardized integration.

Overview

Version 1.6.1 introduces new features to improve user assistance and administrative control. This release adds an AI-powered assistant for in-product documentation queries and provides a mechanism for administrators to initiate on-demand update checks.

Added Features

This release includes the following new features.

In-Product Documentation AI Assistant

A new AI-powered assistant is now available within the product. This feature allows you to get help and answers to questions about product usage without leaving the user interface.

The assistant's responses are generated directly from the official product documentation. You can also provide feedback on the answers, which helps to improve the assistant's quality over time.

On-Demand Update Checks

Administrators now have the ability to trigger an update check on demand.

This release introduces significant enhancements to on-premises relay connectors, focusing on administrative control, security, and expanded network capabilities.

New Features

Version 1.6.0 includes the following new features.

Relay Connector Management and Security

API publishers can now manage on-premises relay connectors directly from the administration interface. This provides centralized control over connector lifecycle and security credentials.

Key capabilities include:

• Issuing Connector API Keys: Administrators can generate new, secure API keys for connectors.
• Revoking Connector API Keys: Existing API keys can be revoked at any time from the administration interface, immediately disabling the corresponding connector's access.

Bidirectional Relay Connector Capabilities

The functionality of on-premises connectors has been expanded to support bidirectional traffic flows, enhancing integration between central platform services and services running in a private environment.

How It Works

Connectors now include local proxy capabilities, enabling them to securely forward traffic originating from the on-premises environment to central services.

Simultaneously, security for traffic moving in the other direction has been hardened. When a central service sends a request to an on-premises backend via the connector, the connector restricts which hosts it is allowed to contact. This is enforced using a host allow-list.

The diagram below illustrates the bidirectional traffic flow managed by the relay connector.

flowchart TD
    subgraph "On-Premises Environment"
        B[Customer Backends]
        C[Relay Connector]
    end
    A[Central Services]

    C -- "Forwards traffic to" --> A
    A -- "Forwards traffic via" --> C
    C -- "Requests (restricted by host allow-list)" --> B

v1.5.6

This release introduces features to streamline license management and improve visibility into the automatic update process.

Added

• Automatic License Management: The platform can now be configured to automatically retrieve and install its license. This removes the requirement for manual license file uploads after the initial system enrollment.

• Update Controller Status: The Settings → Updates page now features a "Release controller" section. This section displays the status, current version, and the outcome of the last update attempt for the component that manages automatic updates.

• Enhanced Update Notifications: The Settings → Updates page now displays a detailed notification. The source does not specify the content or trigger for this notification.

This release resolves issues related to automated system updates and health check monitoring.

Fixed

This version includes the following fixes:

• Automated Updates: Corrected a condition where automated system updates could fail or perform an unexpected rollback. This issue occurred when the update process encountered database migration tasks or services configured with relative health check URLs.
• Health Monitoring: Fixed an issue that caused deployment-time validation probes to fail for services. The failure was triggered by the presence of leading or trailing whitespace in the configured health check URLs. The system now correctly handles such whitespace.

This document provides the release notes for version 1.5.4.

New Features

Developer Role

This release introduces a new Developer role. This role is designed for team members who need to manage services without requiring full administrative privileges.

Users assigned the Developer role have permissions to perform the following actions:

• Manage service lifecycles
• Import WSDL definitions
• Manage service versions
• Configure conversion overrides
• View discovery data

This role allows for more granular access control, enabling developers to operate on services while restricting access to platform-wide administrative functions.

Fixes

Role Management Permissions

Previously, the ability to manage user roles was not exclusively limited to Administrators. This change ensures that only designated administrators can alter user permissions within the platform.