Breaking changes

5.19

Navigation menu has been restructured

The BCI style guide for the navigation menu introduced sections in the menu. Web Portal now provides these sections. Views that are not yet linked to a section are shown in the Miscellaneous section.

Navigation menu has new HTML tag

The bci-portal-navigation web component has been replaced by a new Angular component. Therefore, the HTML tag has changed. Don’t use HTML tags to reference elements but their data-test attributes. This change is potentially breaking tests that rely on HTML tags instead of data-test attributes.

Replace bci-portal-header-banner with bci-banner

The bci-portal-header-banner web component has been replaced with the bci-banner Web Core component. CSS selectors may need to be adjusted. The method showBanner() of the IframeIntegrationLibrary can be used as before. This change is potentially breaking tests that rely on HTML tags instead of data-test attributes.

Remove "widgetItems" property from getDashboardWidgetsMetaData of IframeIntegrationLibrary

The widgetItems property has been removed from the getDashboardWidgetsMetaData method of the IframeIntegrationLibrary. The method now returns an array of WidgetMetaData objects.

5.17

Removal of registration V1 API

The registration API in V1 is no longer supported by Web Portal. These APIs have been removed from the codebase and will not return.

5.16

Removal of Functions on window.BCIPortal

The following functions will no longer be available on the global window.BCIPortal object. * dispatchMessage * dispatchEvent * showBanner * hideBanner Please use the corresponding functions in the iframe integration library instead.

5.15

API documentation document validation does not allow path duplicates

A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object’s url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it’s up to the tooling to decide which one to use.

— OpenAPI Spec 3.0
https://spec.openapis.org/oas/v3.0.3

The OpenAPI specification has defined this since version 3.0.0, but the validation was not implemented in the library used by the backend. Now, the validation will fail if there are duplicate paths in the API documentation.

Example:

The following paths are considered identical and invalid:

/pets/{petId}
/pets/{name}

Solution:

Use different paths or explain the ambiguity in the API description.

5.14

Deprecation of registration V1 APIs

With the introduction of Registration V3, the following APIs are marked as deprecated and will be removed in future releases. Please use the new V3 registration APIs instead.

Get all modules from registry V1
- GET: /api/core/api/v1/registry/systems
- GET: /registry/api/v1/registry/systems
Get module info from registry V1
- GET: /api/core/api/v1/registry/systems/{id}
- GET: /registry/api/v1/registry/systems/{id}
Change or create a module in the registry V1
- PUT: /api/core/api/v1/registry/systems/{id}
- PUT: /registry/api/v1/registry/systems/{id}
Delete module from registry V1
- DELETE: /registry/api/v1/registry/systems/{id}
- DELETE: /registry/api/v1/registry/systems/{id}
Create module
- POST: /api/core/api/v2/{tenantId}/registry/systems
- POST: /registry/api/v2/{tenantId}/registry/systems