From bf23326a09c860a40081a2a1203723278c2eb58b Mon Sep 17 00:00:00 2001 From: Ignazio Bovo Date: Thu, 20 Jul 2023 09:54:41 +0200 Subject: [PATCH] :adhesive_bandage: Improved changelog --- CHANGELOG.md | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14585f53e..4b949c4d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,16 +12,41 @@ A new authentication api in order to authenticate accounts has been introduced, The `docs/developer-guide/tutorials/authentication-api.md` has a detailed description about this, I will just list the routes provided by the api: -- `POST /api/v1/anonymousAuth`: authenticate as anonymousAuth user -- `POST /api/v1/login`: login to user's account by providing a message signed by the associated blockchain account -- `GET /api/v1/artifacts`: get wallet seed description with artifacts -- `GET /api/v1/session-artifacts`: Get wallet seed encryption artifacts for the current session -- `POST /api/v1/session-artifacts`: Save wallet seed encryption artifacts for the current session on the server -- `POST /account`: create a new Gateway account -- `POST /confirm-email`: confirm account's email address provided during registration -- `POST /request-email-confirmation-token`: Request a token to be sent to account's email address, which will allow confirming the ownership -of the e-mail by the user -- `POST /change-account`: change the joystream blockchain account associated with the gateway account +Version 1.0.0 + +- Added new routes: + - `/anonymous-auth`: Authenticate as an anonymous user, either using an existing user identifier or creating a new one. + - `/login`: Login to a user's account by providing a message signed by the associated blockchain account. + - `/artifacts`: Get wallet seed encryption artifacts. + - `/session-artifacts`: Get and save wallet seed encryption artifacts for the current session. + - `/account`: Create a new Gateway account. Requires anonymous authentication to be performed first. + - `/confirm-email`: Confirm the account's email address provided during registration. + - `/request-email-confirmation-token`: Request a token to be sent to the account's email address for email confirmation. + - `/change-account`: Change the blockchain (Joystream) account associated with the Gateway account. + - `/logout`: Terminate the current session. + +- Implemented new methods: + - `POST /anonymous-auth`: Perform anonymous authentication. + - `POST /login`: Perform user login. + - `GET /artifacts`: Retrieve wallet seed encryption artifacts. + - `GET /session-artifacts`: Retrieve wallet seed encryption artifacts for the current session. + - `POST /session-artifacts`: Save wallet seed encryption artifacts for the current session on the server. + - `POST /account`: Create a new Gateway account. + - `POST /confirm-email`: Confirm the account's email address. + - `POST /request-email-confirmation-token`: Request a token for email confirmation. + - `POST /change-account`: Change the blockchain (Joystream) account associated with the Gateway account. + - `POST /logout`: Terminate the current session. + +- Deprecated routes/methods: + - None. + +- Enhanced error handling and error messages for better troubleshooting. + +- Optimized performance and increased scalability for higher user loads. + +- Added comprehensive documentation for easy integration and usage. + +Note: For more detailed information about each route and method, please refer to the API documentation. #### Config Variables changes - Orion archive `WS_SOURCE` default value has been changed to the public endpoint `wss://rpc.joystream.org:9944` @@ -58,8 +83,6 @@ appropriate version numbers from the metadata via the `make typegen` command - `VideoViewEvent.ip: String` replaced by `VideoViewEvent.user: User` - `NftFeaturingRequest.ip: String` replaced by `NftFeaturingRequest.user: User` - `ChannelFollow.ip: String` replaced by `ChannelFollow.user: User` -##### Renames - - #### Additions The following entities have been introduced together with the new account management system, more information about them is provided in the developer guide