5.0.0 - 2020-10-20 (S), 2020-10-27 (P)


About Staging and Production Environments
Each API Management SaaS upgrade is available to test in a staging environment before it is pushed to production. Refer to the dates in this change log for:
  • The date that the upgrade is available in the staging environment (S), and
  • The date that the upgrade is pushed to production (P).
Note for customers using API Gateway 9.2 or 10 CR1 and higher
For customers using the API Portal with the Layer7 API Gateway version 9.2 (any CR) or version 10 CR1 and higher, review the following information:
  • API Gateway 9.2
    (any CR):
    There is limited compatibility support when using API Portal 5.0 with API Gateway version 9.2. Do NOT perform update of the integration bundle as part of your 5.0 upgrade. Consequently, a number of new API Portal features will not be available. We recommend upgrading your API Gateway to a later version. See Compatibility Matrix for more information.
  • API Gateway 10 CR1 and higher
    :
    You MUST update the integration bundle and replace the PortalUpgradeAssertion file as part of your 5.0 upgrade. See Update the Integration Software on the API Proxy for more information.

Added

  • Manage Policies with Gateway Bundles
    Policy authors can create policy bundles in the Gateway Policy Plugin and incorporate them into the CI/CD pipeline for easier upgrades and migrations. As Portal Admin, you can import Gateway bundles into the API Portal and deploy them to the proxies managed in API Portal. This enables Portal as the single source of management console for the lifecycle of API Management to include APIs, Applications, Policies (bundles), and other entities.
    For bundles that are of encapsulated assertion type, these bundles are made available as policy templates for reuse during API publishing. Newer build revisions of these encapsulated assertion type bundles can be uploaded to the Portal for deployment to proxies, gaining automated reuse by the existing APIs leveraging the bundle’s policy template.
    For more information on creating Gateway bundles, see the Gateway Policy Plugin documentation.
    For more information on managing policy templates and Gateway bundles in API Portal, see Manage Policy Templates and Manage Policy with Gateway Bundles.
  • New API Portal Dashboard and Menu Bar
    The new and enhanced API Portal Dashboard provides a quick overview of the current state of your API Portal. Upon logging in to API Portal, you see a personalized view of menu options, entities and analytics depending on your role or customization.
    For more information, see API Portal Dashboard.
  • API Hub

    • API Hub: Manage Applications
      Portal Admin, API Owner, Org Admin, and Org Publisher can now manage applications using API Hub.
      Applications that you add using API Hub are available in API Portal. Note that global publishers (Portal Admin and API Owners) can also continue to create and manage applications in API Portal.
      For more information, see Manage Applications using API Hub.
    • API Hub: Remote Hosting
      You can now host your customized API Hub using your own hosting solution. Ensure that you have properly defined your hosting environment in your configuration. Work with your Portal Admin to define the configurations for your customized API Hub in the
      config.js
      file.
      Following that, you can register the hosting domain of your customized API Hub with the Layer7 API Developer Portal.
      For more information on registering the hosting domain, see Customize and Extend the standard API Hub.
      For more information on defining this file for a customized API Hub, see the the API Hub Example App GitHub page.

Changed

  • Global Theme and Page Appearance Updates
    In conjunction with the new API Portal look and feel, your theme and page appearance experience has been upgraded.
    The following properties have been added to themes:
    • Color: UI Background color, API Hub primary color, API Hub secondary color
    • Typography: API Hub font
    • Font size: Title, Section title, Small title, Label, Small label
    The following properties are no longer supported:
    • Navigation
    • Header and footer
    • Background image
    Upon upgrade, your global theme will include a number of new properties from the default theme. Additionally, the default values for some existing properties have been changed. Changes are automatically applied; validate your settings for any impact on your existing global theme and appearance.
    For more information, see Customize Page Appearance.

Deprecated

  • Portal.svc Resource
    Customization for Sign Up and Account Setup pages are made by making calls to Portal.svc endpoints for payload delivery, query, and validation.
    The following changes have been made:
    • /admin/Portal.svc/Registrations endpoint now validates the unique organization when a new user signs up for an account.
    • /admin/Portal.svc/accountSetup endpoint now validates the unique username when a new user completes the account setup.
    The following endpoints no longer need to be explicitly called have been deprecated:
    • /admin/Portal.svc/OrganizationNameUnique
    • /admin/Portal.svc/UserNameUnique
  • (Imminent) API Explorer
    The API Explorer application will be deprecated in a future release. You will be able to access Portal’s native APIs (including PAPI, Portal Metrics API, Login API, and Authorization API) as individual APIs from the menu bar. This will also give you the ability to view and test the APIs using the Swagger UI
  • (Imminent) Adobe CQ5
    With the launch of API Hub as the one-stop, customizable platform serving your API consumers and developers, support for creating custom pages using Adobe CQ5 will be removed in mid-December 2020.
    For more information on Adobe CQ5 deprecation, see Layer7 API Management SaaS - Adobe CQ5 Deprecation.

Fixed

Issue
Resolution
DE445856
Addressed a vulnerability issue with server information being displayed in 500 error codes.
DE453331
Fixed an issue that caused the Applications list to disappear when adding API to Applications from the API Details page.
DE452335
Fixed an issue that caused the Action button to not appear when adding API to Application in the API Details page.
DE453523
Fixed an issue where you could not access or bookmark the document using the URI from an API document.
DE463137
API Hub: Addressed an issue that caused incorrect text to appear on the home page when switching languages.
DE478547
API Hub: Addressed an issue with /apihub redirecting to port 8443, which resulted in a redirect error.
DE467651
API Hub: Addressed an issue where a successful SAML login was redirecting back to API Portal home page instead of the API Hub home page.
DE465047
Addressed a sync issue where Gateway-published APIs deleted from the Gateway were still showing up in API Portal.