1.3.0

What's new

• NEW: Reimplemented the reasoner and we now support several levels of reasoning! See our documentation for more info.
• NEW: (#523) Added REST API operation to return Knowledge Gaps
• NEW: (#512) Improved way to configure the Knowledge Engine using MicroProfile Config standard
• Improved documentation on docs.knowledge-engine.eu
• Improved workflows to simplify release process
• Fixes #581: Implemented a KB (separate from Admin UI) to exchange metadata
• Fixes #573: Resolved bug in rest-api example where healthcheck fails
• Fixes #563: Implemented several improvements based on code review
• Fixes #531: Handle TimeoutException when using the reasoner
• Fixes #525: Improved visualization of reasoning graph with number of matches on edges
• Fixes #513: Fixed error when including Knowledge Engine as a maven dependency
• Fixes #505: Added operation to reload metadata for Admin UI
• Fixes #503: Added test to show 'generalize if necessary' scenario
• Fixes #515: Added smoke test to detect issues with Docker images
• Updated dependencies

Details

• Prepare for snapshot by @bnouwt in #511
• Add two necessary jersey dependencies. by @bnouwt in #514
• Bump org.slf4j:slf4j-simple from 1.7.25 to 2.0.13 by @dependabot in #504
• Bump org.apache.maven.plugins:maven-surefire-plugin from 2.22.2 to 3.2.5 by @dependabot in #492
• Add a new tests that illustrates the improvements made with the matcher. by @bnouwt in #524
• Bump jersey3-version from 3.1.3 to 3.1.7 by @dependabot in #521
• Add smoke test to detect issues with Docker images by @Sophietje in #515
• Bump org.codehaus.mojo:build-helper-maven-plugin from 3.5.0 to 3.6.0 by @dependabot in #520
• Bump com.squareup.okhttp3:okhttp from 4.9.1 to 4.12.0 by @dependabot in #494
• Bump jakarta.servlet:jakarta.servlet-api from 5.0.0 to 6.1.0 by @dependabot in #522
• Add unit test for reasoner video. by @bnouwt in #503
• 411 implement combimatch to improve reasoner performance by @bnouwt in #526
• Add (timeout) exceptions to exchange info. by @bnouwt in #536
• Bump swagger-core-version from 2.2.20 to 2.2.22 by @dependabot in #528
• Bump jackson-version from 2.16.1 to 2.17.2 by @dependabot in #527
• 535 fix includemetakis call in reasonerprocessor by @bnouwt in #538
• Added a more useful ReasonerPlan toString. by @bnouwt in #534
• Bump org.apache.maven.plugins:maven-shade-plugin from 3.5.1 to 3.6.0 by @dependabot in #540
• Bump org.junit.jupiter:junit-jupiter from 5.10.2 to 5.11.3 by @dependabot in #548
• Bump org.junit.jupiter:junit-jupiter-engine from 5.7.0 to 5.11.3 by @dependabot in #549
• Bump org.ehcache:ehcache from 3.9.9 to 3.10.8 by @dependabot in #473
• Make AdminUI in distributive setup more useful. by @bnouwt in #553
• Bump org.apache.jena:apache-jena-libs from 4.10.0 to 5.2.0 by @dependabot in #547
• Bump jersey3-version from 3.1.7 to 3.1.9 by @dependabot in #559
• Bump jackson-version from 2.17.2 to 2.18.1 by @dependabot in #556
• Bump jakarta.validation:jakarta.validation-api from 3.0.2 to 3.1.0 by @dependabot in #560
• Bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.5 to 3.5.2 by @dependabot in #558
• Bump org.openapitools:openapi-generator-maven-plugin from 7.2.0 to 7.9.0 by @dependabot in #557
• Merge Rest api with knowledge gaps into master by @JackJackie in #532
• WIP: Improve documentation by @Sophietje in #554
• Bump jetty-version from 11.0.15 to 11.0.24 by @dependabot in #565
• Bump org.apache.maven:maven-model from 3.9.4 to 3.9.9 by @dependabot in #566
• Bump ch.qos.logback:logback-core from 1.4.14 to 1.5.12 by @dependabot in #568
• Bump jackson-version from 2.18.1 to 2.18.2 by @dependabot in #570
• Bump swagger-core-version from 2.2.22 to 2.2.26 by @dependabot in #572
• Update docker-compose.yml by @bnouwt in #574
• Improve documentation by @Sophietje in #575
• Bump org.slf4j:slf4j-simple from 2.0.13 to 2.0.16 by @dependabot in #577
• Bump org.openapitools:openapi-generator-maven-plugin from 7.9.0 to 7.10.0 by @dependabot in #576
• Bump jakarta.xml.bind:jakarta.xml.bind-api from 4.0.1 to 4.0.2 by @dependabot in #579
• 563 code review by @bnouwt in #580
• 512 improve configuration of the knowledge engine by @bnouwt in #569
• 581 update admin UI implementation to make meta functionality reusable by @bnouwt in #583
• Simplify process of making releases by @Sophietje in #582
• Bump org.junit.jupiter:junit-jupiter-api from 5.11.3 to 5.11.4 by @dependabot in #584
• Bump swagger-core-version from 2.2.26 to 2.2.27 by @dependabot in #578
• Prepare for release 1.3.0 by @Sophietje in #589

New Contributors

• @JackJackie made their first contribution in #532

Full Changelog: 1.2.5...1.3.0

1.2.5

• PR #509: Make our documentation more user friendly with search, code highlights and even a dark mode. We also made it available on docs.knowledge-engine.eu!
• #495: Fixed knowledge directory version docker image that failed to start.
• #506: Solved bug where typed literals were converted into plain literals.
• #440: Solved bug in reasoner where KB was asked the same question multiple times.

Full Changelog: 1.2.4...1.2.5

1.2.4

• Upgrade base image + upgrade libraries fixing critical and high CVE by @johankumps in #14
• Fixes #451: Moved log statements about meta interactions to debug level
• Fixes #456: Avoid exception when SmartConnector is called after it has stopped
• Fixes #457: Removes possibly sensitive data from log files
• Fixes #463: Improved handling of unavailable KERs which caused CompletionException in the logs
• Fixes #474: Added validation for the KE_RUNTIME_EXPOSED_URL
• Fixes #475: Send correct KER id in DELETE /runtimedetails/{id} calls
• Fixes #480: Handle NullPointerException when receiving a message with an unknown id
• Create initial CI workflow with Github Actions
• Upgraded dependencies for junit-jupiter-api, jgrapht-core, openapi, jersey, javax validation-api, builder-helper-maven-plugin, maven-shade-plugin, openapi-generator-maven-plugin, apache-jena-libs (#461, #460, #462, #9, #468, #466, #465, #472, #471, #467)

New Contributors

• @johankumps made their first contribution in #14

Full Changelog: 1.2.3...1.2.4

1.2.3

• Improve stability and recoverability when running the KE in distributed mode
• Solve memory leak by too many unhandled handle requests

1.2.2

• Improve inter KER communication using timeouts, log statements and detecting unreachable KERs.

1.2.1

• Fixed a bug related to using authentication in distributed mode.

1.2.0

• Major improvements to the reasoner, making it more powerful. See this blog post for more information.
• It is now possible to provide Basic Authentication information within both the KE_RUNTIME_EXPOSED_URL and KD_URL environment variables that are used in distributed mode. This allows restricting participation in the data exchange to those who have a valid username and password. Note that Basic Authentication is only secure if combined with HTTPS and actually adding Basic Authentication and HTTPS requires the use of a correctly configured reverse proxy like NGINX.
• Improved knowledge base ID validation. This could be breaking if you use an invalid URL under certain circumstances.
• Knowledge base ID uniqueness check in distributed mode. If two knowledge bases currently use the same knowledge base ID in distributed mode (in different runtimes), it does not give a clear error in version 1.1.3 (although it probably behaves incorrectly), but in this version it will give a clear error when registering your knowledge base.
• This version requires Java 17 instead of Java 11.

1.1.3

• It is now supported to select multiple Knowledge Bases with a recipient selector.
  • For an example using this feature via the REST API, refer to the examples in the OpenAPI specification of the proactive interactions
• It is now not possible anymore to confuse other Smart Connectors by lying to them via a client Knowledge Interaction, telling that your Knowledge Base can do certain things that it actually cannot.
• The Docker images are now built for multiple processor architectures (linux/arm64 and linux/amd64) to support more platforms.

1.1.2

• Stricter binding validation
  • This could break some cases where the Knowledge Engine is used incorrectly. To see an example of something that breaks, check out the description of the issue.
  • This strict validation is enabled by default, but can be disabled by setting SC_VALIDATE_OUTGOING_BINDINGS_WRT_INCOMING_BINDINGS=false
• When running the KE REST server, there is now a path /rest/version where you can retrieve the version of the Knowledge Engine that is running.
• Knowledge Base Ontology is now called Knowledge Engine Ontology, as it concerns more than just Knowledge Bases.
• Ontology base URI has been changed from https://www.tno.nl/energy/ontology/interconnect to https://w3id.org/knowledge-engine. (We still have to configure the redirect with w3id.org, but this is possible.)
• Stability & performance improvements
• Fixed bug where the REST API incorrectly returns HTTP 500.

1.1.1

• :scales: Stability improvement :scales: : When the two first requests for the KE REST server arrive almost simultaneously, it will now correclty create only a single RestKnowledgeBaseManager.
• 🚀 Performance improvement 🚀 : When using the Knowledge Engine in distributed mode, different KE runtimes will now find each other much quicker!
• ✨ New feature! ✨ : It is now possible to optionally provide a name when registering a Knowledge Interaction. If the name is given, it is used instead of a UUID to build the Knowledge Interaction's URI. See the example in the OpenAPI spec.
• Updates to the revamped admin-ui module: The Admin UI is a Knowledge Base that provides information about other Knowledge Bases via a REST API. This will be used in a front-end (Knowledge Explorer) where the Knowledge Network can be visualised and administered.
• Removed/lowered a lot of logging. Special care was taken to lower the amount of privacy-sensitive data that is logged.