HyP3 v7.2.0
This release includes changes to support an upcoming user whitelisting feature. A new user will be required to apply for HyP3 access and will not be able to submit 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.
- 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
.
- Add field
Added
- A new
PATCH /user
endpoint with a singleuse_case
parameter allows the user to submit an application or update a pending application. The structure for a successful response is the same as forGET /user
. - A new
default_application_status
deployment parameter specifies the default status for new user applications. The parameter has been set toAPPROVED
for all deployments.
Changed
- The
POST /jobs
endpoint now returns a403
response if the user has not been approved. - 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
, orREJECTED
. - 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.
- A required
Removed
- The
reset_credits_monthly
deployment parameter has been removed. Credits now reset monthly in all deployments. This only changes the behavior of thehyp3-enterprise-test
deployment.