Skip to content

1.6.0
Compare
Choose a tag to compare
@WadeBarnes WadeBarnes released this 08 Feb 19:43
· 159 commits to master since this release
1.6.0
f97c248
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Summary of major changes:

Additional details, including the information here, can be found in; Please prepare for Release 1.6.0 of Aries VCR

API

Topic Search Changes and OrgBook BC BN Searching

This change introduces major updates to search, adding a v4 API. The early versions of the API (v2 and v3) are unchanged from a signature perspective, but the data returned may change in some cases (see below).

Topic searches in previous versions were based on Credential attributes that were linked back to their owner Topics. This resulted in duplicate Topic results when query terms (such as names) match multiple Credentials. The v4 API introduces Topic search endpoints that are based on Topic attributes. Topic attributes are an aggregation of their owned Credential attributes. This change requires rebuilding SOLR indexes.

In the OrgBook BC deployment, this update was accompanied by a change to the categorization data, adding the BN (Business Number) to the "names" vs. a credential attribute to enable searching by attribute. As a result, some existing APIs were initially altered to include the BNs. Before releasing to production, a change (see below) filtered the BN results out for the existing v2 API searches.

We recommend that OrgBook API clients should migrate to the new version of the search API to enable support for BN searching.

Change log:

Server

  • Introduces new search API endpoints for Topic (/v4/search/topic) and Credential (/v4/search/credential). Search API endpoints for Credential are derived from v3
  • New index fields introduced for Topic that allow searching on Name, Address and Source ID
  • Fixes issue with filtering Topic/Credential by category facets, where result set was not narrowed down by selection
  • General code cleanup

Exclude names other than entity_name and entity_name_assumed in formatted Topics

As noted above, in order to retain the same data semantics as in the previous v2 search, additional names (notably the BN) have been filtered out of the the following endpoints:

  • v2/topic/{id}/formatted
  • v2/topic/ident/{type}/{source_id}/formatted

Fix typo in api/v3/views/rest.py

Fixes a typo that prevents the credential verification logic in the UI from working.

OrgBook BC Front End Client

Updates for API Additions

Updates to use new and evolved API calls in the OrgBook BC front end:

  • Upgrades basic and advanced search to v4 from v3
  • Adds new facets to advanced search for Credential types
  • Upgrades autocomplete to v3 from v2, which expands autocomplete beyond Names to include Address and Source ID
  • Improves advanced search handling of URL query parameters to allow for bookmarking of queries. URL query parameters are also carried over from basic search to advanced search
  • Aligns historical facet filtering for basic and advanced search
  • General code cleanup

Fixes a name display bug with External Schema/Services.

When 'name.' + is not found in i18n translations, entry displays as unformatted key. This fix strips the ‘name.’ prefix so just will display.

Angular upgrade

This PR upgrades the client Angular application to 11.02

Change log:

  • Upgrades Angular to 11.02 (Note: this upgrade removes support for IE <= 10)
  • Replaces localization-router node package and associated http loader
  • Updates style imports

Adds collapse list of alternate names for credential search results

This PR adds topic display names and a collapsable element of alternate topic names/identifiers to OrgBook search results.

Change log:

  • Fixes an issue where topic search results showed a blank name if topic credentials did not use prescribed name types.
  • By default, the topic source_id is displayed for topic search results otherwise the display name is derived from name types in the following order:
    • display_name, entity_name_assumed, entity_name
  • If topic names other than the display name are available, remaining names/identifiers are displayed in a collapsable element
  • Removes local and remote names on credentials unless an entity_name and entity_name_assumed is mapped to credential
  • Adds localization to Credential Types dropdown in Advanced Search
  1. Add remote debugger configuration and docs for vcr-server.

The remote debugger for vcr-server is now available when setting DJANGO_DEBUG=True. The default value for DJANGO_DEBUG has also been set to False, to avoid running the debugger unintentionally.

General Changes

Adds documentation for updating BN in db Name table

Documentation for enabling autocomplete search on BN in existing Aries-VCR databases

Add project lifecycle badge, license badge

Added project lifecycle badge. For lifecycle badge information, see: https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md

Audits and updates production npm package vulnerabilities

Dependency updates.

Assets 2
Loading