APIIDA API Gateway Manager

Release Notes 2023.2

Owned by Marilena Müller
Last updated: Oct 16, 2023 by Markus Müller
3 min read

BREAKING CHANGES to the Management API. See the migration information below to update your CI/CD pipelines.

Please note, that you have to reindex your gateways before groups and users of all of your identity providers show up in the API Gateway Manager.

https://apiida.atlassian.net/wiki/spaces/AAGM/pages/8156741649

Bug Fixes

  • Now you can also reliably specify the name of the cluster instead of the node in API Gateway Manager’s API as a target in migrations.

  • If migrating to multiple targets and one of the targets was not reachable when preparing a migration, the error message now contains the name of the target for easier troubleshoting.

  • During the transition to version 2023.1 an error could happen where the ldap host got an additional "ldap://".

  • The dashboard alarms widget now also includes the "SOLVED BUT UNCONFIRMED" alarms.

  • Special characters in the names of folders and url patterns of APIs are now transferred exactly as they are. Layer7 uses an inconsistent escaping for characters. Using standard escaping caused issues with some characters and resulted in an “INVALID_VALUES” error message during migrations.

  • For new installations, the charset for a database field is now set correctly (see https://apiida.atlassian.net/wiki/spaces/AAGM/pages/8087371777 ). If you find the error message in the log files that is described in the linked knowledge base article, please contact customer support or change the charset of the field as described in the post.

  • Groups and users of identity providers other than the defalt identity provider are not marked as “missing on source” anymore during migrations.

Changes

  • API Gateway Manager is now ready to work with all the other APIIDA products!

  • The Management API of the API Gateway Manager has been redesigned. Attention! Breaking changes. You should check your pipelines. Our customer support team is happy to help you with any changes needed.

    • The login must now happen with POST and username and password must be specified in the body of the request.

    • Entities are now updated with PATCH.

    • Endpoints have been named more meaningfully and have a much more detailed description of what they do and how they should be used.

  • The handling of libraries has been improved.

    • To create a new library there is now a button directly in the APIs view.

    • A library can now be updated. You no longer have to create it over and over again.

    • Checking whether a library is present on the target during a migration is now more accurate and also shows whether it should be updated on the target.

  • In the overview of the resources of a node there is now a search function.

  • The settings in the configuration have been sorted and grouped in a more reasonable way.

  • During a migration, the differences of a resource from source and target are now better displayed with a click on the eye symbol.

  • The groups and users of all identity providers are now indexed as part of creating the digital twin. To access the groups and users select an identity provider in the gateway explorer available via the “Resources” link in the main menu. They will be displayed on the right hand side.

  • The API Gateway Manager now supports migrating groups and users of identity providers even if the provider they belong to has different IDs on the source and target gateways. This fills a gap in Restman, that is not capable of resolving the mapping correctly.

  • Roles are now checked more rigorously in the API. Please make sure that the user you use in your pipeline has the needed rights. Check with the migration guide for more information.

Other changes

  • The time of the last reload of a node's resources is now displayed inside the node.

  • The error messages returned by the Management API have been redone to be more concise and clear.

  • When adding a requirement to a library or solution kit, multiple ones can now be selected at once.

  • Instead of the generic error message that was displayed in prior versions when authentication via LDAP fails the error messages of the LDAP server itself are now surfaced to the UI. You do not need to go to the logs to find them.