The user identifier at data.<identifier> is not really intuitive, especially because no other properties within data will be used anyways. Furthermore, as <identifier> depends on the instance's configuration, it is unknown without executing GET /instance-configuration as well, making the current implementation both unintuitive as well as hard to use.
[x] Change endpoint while keeping the old behavior available. Keep the old behavior behind a feature flag which is on by default, and will be disabled with the release of version 0.2.0.
[x] Change the variable name user to uniqueUserIdentifier in the POST /token endpoint, keep the old logic available behind a feature flag as well.
[x] Change the endpoint POST /register in a similar fashion.
[x] Update unit tests. Mark old tests as deprecated.
[x] Update feature tests.
[x] Update documentation, especially graph & example generation.
[x] Mark this as a breaking change in the change log.
[x] Add new task in CI/CD for old, replaced feature tests.
The
POST /change-password
endpoint is currently using the following request body scheme:The user identifier at
data.<identifier>
is not really intuitive, especially because no other properties withindata
will be used anyways. Furthermore, as<identifier>
depends on the instance's configuration, it is unknown without executingGET /instance-configuration
as well, making the current implementation both unintuitive as well as hard to use.The current solution was developed during #121 .
The proposed solution is as following:
Tasks
0.2.0
.user
touniqueUserIdentifier
in thePOST /token
endpoint, keep the old logic available behind a feature flag as well.POST /register
in a similar fashion.