Serge Huber created UNOMI-1012:
----------------------------------
Summary: Present the compatibility mode as working for Unomi 2 and
Unomi 3 clients
Key: UNOMI-1012
URL: https://issues.apache.org/jira/browse/UNOMI-1012
Project: Apache Unomi
Issue Type: Improvement
Affects Versions: unomi-4.0.0
Reporter: Serge Huber
Fix For: unomi-4.0.0
h3. Summary
Unomi 4 has a single-tenant compatibility mode that lets existing applications
keep working without the new API keys. It was written when the multi-tenant
release was planned as "Unomi V3". Because of this, the manual, log messages
and code comments call it a "V2 compatibility mode" and describe a move "from
V2 to V3".
The multi-tenant release is now Unomi 4. The mode is the bridge for
applications written for Unomi 2 and for Unomi 3. Users upgrading from 3.0 may
think the mode is not meant for them.
The goal of this ticket is that the documentation and messages describe the
mode as working for Unomi 2 and Unomi 3 clients, and say clearly where the two
differ.
h3. Ways to explore
* Rename the manual page and its text to describe a compatibility mode for
Unomi 2 and 3 clients. Keep the old page anchor so existing links keep working.
* Update the other pages that mention the mode: the migration guides, what's
new, security, and the tracker pages.
* Update log messages and code comments that call the 4.0 server "V3". The
configuration setting name is already neutral and stays as it is.
* Say which 3.0 behaviours the mode keeps and which it does not. For
third-party servers, see UNOMI-1001.
h3. How to test
Manual check: search the manual and the log messages for "V2 compatibility" and
for "V3" used to mean the 4.0 server. None should be left, apart from
historical notes.
Automated tests to add:
* The compatibility mode integration tests cover a client flow written for
Unomi 3.0 (public requests, protected events and admin calls), not only a 2.x
flow.
* The existing compatibility mode tests still pass.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
