changelog

CHANGELOG.md

@@ -4,6 +4,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.2.0]
+
+This release includes changes to support an upcoming user whitelisting feature. A new user will be required to submit an application for a monthly credit allotment and will not be able to submit HyP3 jobs until an operator has manually reviewed and approved the application. As of this release, all new and existing users are automatically approved without being required to submit an application, but this will change in the near future.
+
+⚠️ Important notes for HyP3 deployment operators:
+- Changing a user's application status (e.g. to approve or reject a new user) requires manually updating the value of the `application_status` field in the Users table.
+- The response for both `/user` endpoints now automatically includes all Users table fields except those prefixed by an underscore (`_`).
+- The following manual updates must be made to the Users table upon deployment of this release:
+  - Add field `application_status` with the appropriate value for each user.
+  - Rename field `month_of_last_credits_reset` to `_month_of_last_credit_reset`.
+  - Rename field `notes` to `_notes`.
+
+### Added
+- A new `PATCH /user` endpoint with a single `use_case` parameter allows the user to submit an application for a monthly credit allotment or update a pending application. The structure for a successful response is the same as for `GET /user`.
+- A new `default_application_status` deployment parameter specifies the default status for new user applications. The parameter has been set to `APPROVED` for all deployments.
+
+### Changed
+- The `POST /jobs` endpoint now returns a `403` response if the user has not been approved for a monthly credit allotment.
+- The response schema for the `GET /user` endpoint now includes:
+  - A required `application_status` field representing the status of the user's application: `NOT_STARTED`, `PENDING`, `APPROVED`, or `REJECTED`.
+  - An optional `use_case` field containing the use case submitted with the user's application.
+  - An optional `credits_per_month` field representing the user's monthly credit allotment, if different from the deployment default.
+
+### Removed
+- The `reset_credits_monthly` deployment parameter has been removed. Credits now reset monthly in all deployments. This only changes the behavior of the `hyp3-enterprise-test` deployment.
+
 ## [7.1.1]
 ### Changed
 - Reduced `start_execution_manager` batch size from 600 jobs to 500 jobs. Fixes [#2241](https://github.com/ASFHyP3/hyp3/issues/2241).