API Management Release Notes
Migration Notes
The following bugfixes and features are subject to migration. Please perform the necessary migration tasks.
Release Notes of the API Management Version 7
API Management 7.7.0 (31.03.2021)
As of this version, API Management is not available standalone anymore but only as a component of Scheer PAS. Users who are updating from a lower version need to perform migration tasks.
| Bug | Description | Documentation Link |
|---|---|---|
| GW-64 | Plugins: E2E-CatalogPlugin: Better error messages | |
| GW-257 | REST API: User homepage is accessible by divergent user | |
| GW-300 | REST API: Check REST API Security and Permissions | |
| GW-324 | UI: Cannot delete retired API: Unexpected Server Error | |
| GW-328 | DevPortal: Save of client mapping causes sometimes problems | |
| GW-335 | DevPortal: Optimize Devportal Admin View | |
| GW-338 | Plugins: API Catalog does not load correctly | |
| GW-349 | DevPortal: Check token refresh interval | |
| GW-357 | Gateway: Do not write to response if the connection is already closed (Handle java.lang.IllegalStateException: Response is closed)) | |
| GW-374 | Gateway: Problems with "persistent connections" (keep-alive) | |
| GW-385 | DevPortal: Use double quote for base path in html | |
| GW-394 | UI: "Tools" Menu is only visible for apiadmin and not for apiuser | |
| GW-403 | Docker: Fix CVE-2020-13935 | |
| GW-404 | Gateway: Gateway does not handle proxy headers that indicate the real ip | |
| GW-415 | Plugins: API Catalog Connection Error | |
| GW-427 | DevPortal: Dev portal: URL contains ? instead of & | |
| GW-432 | Gateway: Exception while unregister client | |
| GW-447 | UI: Filter in API search dialog doesnt work | |
| GW-457 | DevPortal: Load Definition: Re-Publish button is only enabled after refreshing page | |
| GW-463 | UI: Re-register button is not enabled after removing a policy | |
| GW-465 | UI: The boxes on start page should link to "My APIs" etc. | |
| New Feature | Description | Documentation Link |
| GW-207 | Elasticsearch: Support for Elasticsearch 7 | |
| GW-344 | UI: Paging of all APIs/Organizations | |
| GW-352 | DevPortal: Allow download of swagger/wsdl-files in devportal | |
| GW-354 | Plugins: Header Allow/Deny Policy | |
| GW-359 | Plugins: API Catalog: Allow connection to BRIDGE via HTTP | |
| GW-360 | Gateway: Gateway should work without all certificate files | |
| GW-363 | Docker: Kibana SSO Integration | |
| GW-392 | Docker: Change default value for ${API_MGNT_SELF_SIGNED_CERT} to true | |
| GW-434 | Docker: Allow easy configuration for KeycloakOAuthPolicy for Designer Integration | |
| GW-455 | Gateway: Create configuration to use self-signed certificates in PAS | |
| Improvement | Description | Documentation Link |
| GW-87 | Gateway: API Management REST API | |
| GW-204 | UI: Support new java versions | |
| GW-255 | DevPortal: DevPortal Api-View: List public apis | |
| GW-310 | DevPortal: HTTP Support | |
| GW-319 | Docker: Change default values in .env to match the ones in the documentation | |
| GW-327 | DevPortal: Show name instead of id in editor dialoag | |
| GW-333 | Gateway: Change gateway response if the API Endpoint cannot be reached | |
| GW-336 | DevPortal: Handle readonly keycloak users within Devportal | |
| GW-337 | Gateway: Gateway should return which policy causes the error | |
| GW-339 | DevPortal: Beautify "Add Developer" button | |
| GW-343 | UI: Allow only Javascript Number.MAX_SAVE_INTEGER for rate limiting policy in the UI | |
| GW-348 | Plugins: Validate the input of all policies to avoid wrong configuration | |
| GW-353 | REST API: REST API should not send the full stacktrace in the response | |
| GW-365 | Elasticsearch: Optimize index creation for ES 7 | |
| GW-395 | DevPortal: Make online resources offline available | |
| GW-412 | DevPortal: Show only users with "devportaluser" role in the list of developers | |
| GW-430 | UI: Update tomcat to 9.0.38 because of security fix | |
| GW-431 | DevPortal: Scrolling for Create Client Mapping | |
| GW-437 | UI: Change heading in DevPortal Administration from "Create" to "Add" Developer | |
| GW-439 | Elasticsearch: Update opendistro dependency to 1.10.1 | |
| GW-440 | Plugins: Bridge Integration with SSO Bridge | |
| GW-444 | UI: Importer should log file name at startup | |
| GW-446 | Gateway: CORS improvements for Manager REST API | |
| GW-448 | UI: Improve ES Connection Logging | |
| GW-451 | UI: Default paging should display 12 Orgs/APIs instead of 10 | |
| GW-454 | DevPortal: Allow customer to modify links in the about screen | |
| Sub-task | Description | Documentation Link |
| GW-347 | Docker: Make gateway log level configurable in docker-compose.yml |
API Management 7.6.1 (27.02.2020)
Contains:
Elasticsearch 5.6.16
Kibana 5.6.16
Keycloak 8.0.1
Keycloak-Gatekeeper 7.0.0
MySQL 5.7.28
NGINX ngnix:1.17.7-alpine
Tomcat 8.5.50
| New Feature | Description |
|---|---|
| GW-334 | Docker: Make keycloak realm configurable |
API Management 7.6.0 (03.02.2020)
Contains:
Elasticsearch 5.6.16
Kibana 5.6.16
Keycloak 8.0.1
Keycloak-Gatekeeper 7.0.0
MySQL 5.7.28
NGINX ngnix:1.17.7-alpine
Tomcat 8.5.50
Migration Notes 7.5.0 -> 7.6.0
If starting with a clean installation, there is nothing to do. If updating an installation of API Management, follow the steps listed on API Management Migration Notes 7.5.0 -> 7.6.0.
Known Issues:
There is an issue with the CORS policy. If your are updating to API Management 7.6.0 and want to use this policy, please contact our support.
If installing a new API Management 7.6.0, there is nothing to do.
| Bug | Description | Documentation Link |
|---|---|---|
| GW-62 | Plugins: SwaggerDefinition file is only available if the service is running at import | |
| GW-111 | UI: "Copied!" Popup is displayed wrongly | |
| GW-212 | REST API: Fix API-Key Security Issue | |
| GW-232 | UI: API definition loads endlessly if no definition existent | |
| GW-235 | UI: Element status get green when hovering on them | |
| GW-238 | Elasticsearch: API Definition gets not deleted in storage while deleting API | |
| GW-240 | UI: Definition URL is not cloned if you create a new API Version | |
| GW-256 | UI: Broken link on API Details page | |
| GW-277 | UI: Loading of API Definition crashes with some swagger files | |
| GW-284 | REST API: You can not delete an empty API | |
| GW-288 | REST API: Replace Host and Basepath in Swagger Definition also for Devportal Requests | |
| GW-292 | Keycloak: Devportal Admin/User need the acount client role 'view-profile' | API Management Migration Notes 7.5.0 -> 7.6.0 |
| GW-321 | Plugins: CORS Policy is not working | |
| New Feature | Description | |
| GW-109 | DevPortal: View for external customers | |
| GW-220 | UI: Update API Definition from BRIDGE Service via a Button | |
| GW-237 | UI: Import API Definition (Swagger/WSDL) via URL | |
| GW-247 | DevPortal: REST API for Developer Management (Devportal) | |
| GW-253 | DevPortal: Keycloak Migration/Default Settings for new Devportal | API Management Migration Notes 7.5.0 -> 7.6.0 |
| GW-254 | DevPortal: Add export/import functionality for developers (backup and migration) | |
| GW-263 | DevPortal: Admin-View to manage Developers | |
| GW-293 | Docker: Provide own docker image for nginx-proxy | |
| GW-322 | Gateway: CachingESRegistry: Invalidate Cache is not working | |
| Improvement | Description | |
| GW-153 | Gateway: Only support one gateway configuration | |
| GW-242 | Gateway: Add REST resource to get gateway endpoint from gateway | |
| GW-244 | UI: Make API Definition URL not clickable in Browser | |
| GW-260 | REST API: Make Swagger Definition URL available for Developer | |
| GW-264 | DevPortal: Change CORS default behavior for devportal | |
| GW-291 | Docker: Update docker images | |
| GW-307 | DevPortal: Add Links for Developer Portal and Kibana in API Management |
API Management 7.5.0 (08.10.2019)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak(-Gatekeeper) 5.0.0
Kibana 5.6.14
Migration Notes
API Management 7.5.0 features a new policy Caching Resources Policy. To use this policy, you have to import the following configuration file:
Import this file as described on API Management Backup and Restore.
| Bug | Description | Documentation Link |
|---|---|---|
| GW-186 | UI: Swagger file could not be stored - field has to many bytes | |
| GW-196 | Docker: UI not working with keystore password containing & | |
| GW-210 | Policies: Caching Policy throws NullPointerException | |
| GW-229 | Policies: Caching Resources Policy doesn't cache | |
| New Feature | Description | |
| GW-60 | Gateway: Support xUML Services with HTML UI in the catalog | |
| GW-138 | Gateway: Caching Policy | Caching Resources |
| GW-185 | Elasticsearch: Save source ip of a request in elasticsearch | |
| Improvement | Description | |
| GW-39 | UI: API definition: export Swagger YAML or WSDL file | |
| GW-43 | UI: Delete plan improvement | |
| GW-151 | Plugins: Support more than one Bridge in API Catalog Plugin | Installing API Management > Step 2: Configure the Installation Settings |
| GW-155 | Elasticsearch: Rate Limiting Policy support for cluster mode | |
| GW-182 | Docker: Extend validity of generated self-signed-certificates to 3 years | |
| GW-191 | Docker: Remove unneeded .p12 file while creating self-signed-certificates | |
| GW-192 | Plugins: JWT Policy: Support signature verification with JWK(S) | |
| GW-198 | Docker: Check if all needed files are present before startup | |
| GW-199 | Plugins: Added source request header for Simple Header Policy | |
| GW-219 | Docker: Shrink/Squash docker images | |
| GW-226 | UI: Fix Cancel Buttons | |
| GW-231 | Docker: Set fix database values for keycloak |
API Management 7.4.0 (24.06.2019)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak(-Gatekeeper): 5.0.0
Kibana 5.6.14
| Bug | Description | Documenation Links |
|---|---|---|
| GW-112 | Gateway: Swagger "execute" fails: NetworkError when attempting to fetch resource | |
| GW-123 | Plugins: API-Catalog: Show which url you are going to import | |
| GW-173 | Docker: "$PWD" does not work on windows powershell and command prompt | |
| GW-175 | Plugins: API Catalog is unable to load definition file | |
| GW-176 | Gateway: Rate Limiting Policy fails | |
| GW-178 | UI: IE11: Swagger UI Button Rendering | |
| GW-193 | Gateway: Gateway error messages are broken | |
| New Feature | Description | |
| GW-179 | Docker: Add kibana and keycloak-gatekeeper as proxy | |
| Improvement | Description | |
| GW-152 | Docker: Gateway should trust valid certificates | |
| GW-162 | Elasticsearch: Refactor DefaultEs(ES)ClientFactory because it is duplicate code | |
| GW-169 | Docker: Find a better way to create self-signed certificates | Installing API Management |
| GW-171 | Docker: Certificate Handling | |
| GW-172 | Docker: Add configuration files for distributed setups to api-mgmt.zip | |
| GW-181 | Gateway: LDAPS: SocketException: Connection Reset in SSL | |
| GW-183 | Gateway: New default (true) for self-signed certificates flag (SELF_SIGNED) | Installing API Management |
| GW-184 | Docker: Make it possible to disallow older TLS Versions | Advanced API Management Settings > Security Settings |
API Management 7.3.0 (2019/01/31)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak 4.8.3.Final
Migration Notes 7.2.0 -> 7.3.0
If starting with a clean installation, there is nothing to do. If updating an installation of API Management, follow the steps listed on API Management Migration Notes 7.2.0 -> 7.3.0.
| Bug | Description | Documentation Link |
|---|---|---|
| GW-88 | Github: cache clear issue | |
| GW-125 | Support a second gateway | |
| GW-133 | Policies: Rate Limiting Policy: Seems to fail under load | |
| GW-148 | Docker: Login page is broken if self registration is disabled | |
| GW-149 | Docker: The current docker-compose.yml does not work out of the box with Docker for Windows | |
| GW-154 | WSDL file is not loaded via the gateway | Troubleshooting |
| GW-159 | Docker: Endpoint is not correctly displayed in API Mgmt UI | |
| GW-168 | Elasticsearch: Recreation of a plan after delete fails | |
| New Feature | Description | Documentation Link |
| GW-121 | Improve docker logging and set log rotation for docker logs | API Management Logging |
| GW-127 | Docker: Make elasticsearch host configurable in docker-compose and expose ports | |
| Improvement | Description | Documentation Link |
| GW-10 | Redirect to login after session timeout | |
| GW-100 | UI: Open links from Catalog to Bridge Service in a new tab | |
| GW-120 | UI: Improve the configuration | |
| GW-129 | Docker: Make aliases in keystore or/and key- and truststores configurable in docker-compose or .env | |
| GW-130 | Docker: Support HTTPS for Elasticsearch (multiple host setup) | |
| GW-131 | Docker: Upgrade to Keycloak 4.5.0 or newer | |
| GW-134 | Docker: How-to support distributed (several hosts) set-up | |
| GW-143 | Docker: Switch to official oss-elasticsearch docker images without X-Pack | see migration notes above this table |
| GW-158 | UI: Change documentation URL on about page | |
| GW-164 | UI: Fix metrics tooltip in UI | |
| GW-165 | Docker: Add project name to docker-compose |
API Management 7.2.0 (2018/11/01)
Migration Notes 7.1.0 -> 7.2.0
If starting with a clean installation, there is nothing to do. If updating an installation of API Management, follow the steps listed on API Management Migration Notes 7.1.0 -> 7.2.0.
| Bug | Description | Documentation Link |
|---|---|---|
| GW-128 | Docker: Switch to official elasticsearch docker images | Installing API Management |
| GW-135 | Connection was closed on exception with runtime |
API Management 7.1.0 (2018/09/19)
API Management 7.1.0 (2018/09/19)
| Improvement | Description |
|---|---|
| GW-117 | Manager-UI: Scheer PAS corporate design |
API Management 7.0.0 (2018/08/29)
| Bug | Description |
|---|---|
| GW-24 | Manager-UI: Swaggerui - Update to 3.17.4 |
| GW-89 | Manager-UI: GW: order of the tabs in org details page changes |
| GW-91 | Manager-UI: Client/API/Plan details page misses link for tab |
| GW-93 | Filter of all APIs/Organizations |
| GW-94 | Manager-UI: SwaggerUI does not always work, random errors or wrong URL |
| GW-96 | Manager-UI: API Catalog: show the selected categories |
| GW-98 | Manager-UI: REST API: moreInfo should point to our documentation |
| GW-103 | API Import takes first only if more than one E2ERestPortType is exposed on the same port |
| GW-104 | Manager-UI: Sometimes a Browser authentication opens |
| GW-118 | https endpoints run into cert error from vertex |
| New Feature | Description |
| GW-5 | API Management: Docker Images |
| GW-46 | CORS Policy |
| GW-85 | Automatically update plugins |
| Improvement | Description |
| GW-81 | Manager-UI: API Management UI problems |
| GW-82 | Manager-UI: UI: standardization of upper and lower case writing |
| GW-83 | Manager-UI: Change the order of the main menu: Organizations, Clients, APIs, Administration |
| GW-84 | Bridge API 2.7.1 changes |
| GW-90 | Manager-UI: Last (text) corrections - hopefully |
| GW-102 | Update apiman 1.5.0 |
| GW-113 | Manager-UI: Create api-mgmt.zip package |