What's new in Version 10.0.5.2
This page details the enhancements in IBM® API Connect Version 10.0.5.2 since the previous release.
What's new for Developers
- Added the
Datecustom scalar type for GraphQL APIs
- You can use the
Datecustom scalar type in GraphQL APIs to define custom scalars that specify dates. For more information, see Extensions to GraphQL.
- Ability to set the API Designer locale
- You can set a different locale than your current operating system for the API Designer application, by using
--langargument when you start the application. For example, by using the
--lang=esargument when you start API Designer, the language is set to Spanish. For more information, see Setting the locale for API Designer.
- Ability to switch directories in API Designer
- You can switch to a different directory after logging in to the API Designer application UI, by clicking Switch directory on the menu bar in the header. For more information, see Logging in from API Designer.
- OpenAPI validation
- You can now click Validate in the API Manager and API Designer API editors to validate your OpenAPI YAML source. If validation errors are found, you can click each error to navigate directly to the section of the API form that contains the invalid YAML. For more information, see Validating the OpenAPI YAML source.
- Support for multiple OAuth2 flows in OpenAPI 3.0 APIs
- If you're creating or editing OpenAPI 3.0 APIs, you can now select multiple flows (grant types) for your OAuth2 security schemes. For more information about how to create OAuth2 security schemes, see Defining OAuth2 security scheme components.
- Create and manage API keys for platform APIs
- Create API keys associated with your user account, and then use them to authenticate when you call the APIs provided by API Connect. For more information, see Managing API keys.
What's new for API product managers
- Analytics UI enhancements
- The analytics UI now includes the following enhancements:
- All analytics views can be switched between local time and Coordinated Universal Time.
- Analytics charts can be switched between linear and logarithmic axes, selectable from the chart options menu.
- Analytics data can be shown going back to the start of your data retention period, not just the last 30 days.
- When you create and edit queries, the custom time range option now provides precision to the second, rather than the minute.
- Up to 200 events per page now viewable in the discover view tables.
- Updated columns in the discover view, providing clearer and more useful information.
- New query fields for gateway_ip, client_ip, immediate_client_ip. Queries can use CIDR notation to search by subnet.
- New refresh button on dashboards to update the data that is displayed, without the need to reload the browser.
- Ability to save and load analytics queries. Saved queries are stored in the analytics backup.
- Analytics CLI and REST API enhancements
- New filter operators for use with the CLI and REST API: startswith, endswith, regex, notoneof. For more information, see Example toolkit CLI operations.
- Additional variables for customizing the email notification templates
- More variables are available to add to the email notification templates, so that you can define
custom templates with more flexibility when addressing the user that's receiving the email. The
following user variables are now available:
What's new for API consumers
- Consumer analytics redesign
- The analytics dashboards in the Developer Portal are redesigned and enhanced. As well as viewing the standard analytics metrics for APIs at the application and organization level, API consumers can now view additional information, including response time, status codes, number of errors, and API call history.
What's new for Developer Portal administrators
- Use the toolkit CLI to enable and disable maintenance mode on your Developer Portal site
- You can now enable and disable maintenance mode on your Developer Portal site, by using the Portal commands in the toolkit CLI. For more information, see How to enable and disable maintenance mode on your Developer Portal.
- New drupal-state commands available in the Developer Portal command-line tool
- The drupal-state commands enable you to store and retrieve information about the state of your Developer Portal system. For more information, see Using the drupal-state commands.
What's new for DevOps
- New requirement when installing or upgrading Developer Portal subsystem on VMware
- If there are multiple Management subsystems in the same project, you must set the Developer
consumer-apicertificates to match those used by the appropriate Management subsystem to ensure that the Developer Portal subsystem is correctly associated with that Management subsystem.Instructions are included in the following topics:
- Installation on VMware: Configuring the Developer Portal subsystem
- Upgrade on VMware: Upgrading to the latest release on VMware
- New dbClientPrimaryuser certificate
The Management component has a new certificate and secret called dbClientPrimaryuser, see: Internal certificates.
If your deployment is installed on Kubernetes, and you use customized internal certificates, see the additional upgrade step: Add db primary certificate.
If your deployment is installed on OpenShift, Cloud Pak for Integration, or OVA then no action is required.
- Additional requirement for disaster recovery when Management subsystem uses S3 backups
- If you installed API Connect on Red Hat OpenShift or Cloud Pak for Integration by using the
apiconnectclusterCR, you must annotate the CR as part of the disaster recovery process. The instructions for recovering from a disaster include a new step to guide you through the annotation procedure.
- New deployment profiles with new CPU licensing limits
- New deployment profiles are available, and CPU licensing limits updated. The
spec.license.metricnow correctly maps to the
productMetricannotation for the containers that require license entitlement. See CPU limits, Memory limits, and licensing. Some existing profiles are deprecated, see API Connect deployment profiles for OpenShift and Cloud Pak for Integration.
- Portal CR status message field
- A new message field has been added to the output of
kubectl|oc get PortalCluster. This new field provides portal status information, for example:
NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE portal 3/4 Pending 10 10.0.5.2-0 Mounted certificates are not valid 8d portal 4/4 Running 10 10.0.5.2-0 1 site(s) are not in sync with API Manager 8d portal 4/4 Running 10 10.0.5.2-0 Ready for service registration 8d portal 3/3 Running 10 10.0.5.2-0 Ready to create sites 22h portal 3/3 Running 10 10.0.5.2-0 1 site is installing 22h portal 3/3 Running 10 10.0.5.2-0 Serving 2 sites 22h portal 3/3 Warning 10 10.0.5.2-0 Preparing for site upgrade(s) 22h portal 3/3 Warning 10 10.0.5.2-0 Site Upgrades Executing:(0) Queued(1) Failed(0) Success(0) 22h
- Manual portal backup and restore supports multiple portal clusters
- Kubernetes, Cloud Pak for Integration, and
OpenShift only: The portal backup and restore CRs now have a
portalClusterproperty that specifies which portal cluster to apply the backup or restore to. For more information, see: Backing up and restoring .
- New API consumption dashboard
- Monitor total API calls in your cloud with the new consumption dashboard available in the Cloud Manager UI, see Cloud Manager UI analytics view.
- Compatibility matrix for Kubernetes and OpenShift versions included in documentation
- Tables that show which versions of IBM API Connect are compatible with which Kubernetes and OpenShift releases are now provided as a quick reference in the software product compatibility requirements page: IBM API Connect Version 10 software product compatibility requirements.
- Managing Developer Portal backup resources
- If you are using remote backups, and there are a large number of rows in your
portalbackuplist that have a
record, there might be a slow down in system performance, including during Developer Portal upgrades. Although there is no upper limit to how many portal backups you can have, it is recommended that you prune your remote backups so that the number of rows does not become excessively large. One
portalbackuprow of type
record, corresponds to one backup file on the configured remote backup server. For more information, see Overview of the Developer Portal backup resources.
What's new for security practitioners
- Migrate token revocation information to DataPower® API Gateway
- You can use the Token Migration Utility (TMU) to migrate token revocation information from a v5 quota enforcement server (QES) to a gateway-peering cache in v10 DataPower API Gateway. For more information, see Migrating token revocation information to DataPower API Gateway.