Skip to content

Conversation

@rushtong
Copy link
Contributor

@rushtong rushtong commented Dec 2, 2025

Addresses

https://broadworkbench.atlassian.net/browse/DT-2519

Summary

This PATCH API allows for admins, chairs, and data submitters to patch a set of selected values on a study. The top level field values patchable are:

  • Study name
  • Study description
  • Study datatypes (list of strings)
  • Study PI Name
  • Study public visibility (boolean)

Additionally, these study properties can be modified:

  • Study Type (enum that must match a value in the current schema)
  • Phenotype Indication
  • Data Custodian Email (this replicates and makes redundant PUT /api/dataset/study/{studyId}/custodians)
  • Target Delivery Date
  • Target Public Release Date

Reviewer Notes

  • I chose to use Jackson to strictly validate the input json because similar configuration functionality is missing from Gson.
  • The current UI shows the two target dates as unrelated to alternative data file sharing plan, but the fields are saved as alternativeDataSharingPlanTargetDeliveryDate and alternativeDataSharingPlanTargetPublicReleaseDate:
Screenshot 2025-12-03 at 9 48 02 AM

Have you read CONTRIBUTING.md lately? If not, do that first.

  • Label PR with a Jira ticket number and include a link to the ticket
  • Label PR with a security risk modifier [no, low, medium, high]
  • PR describes scope of changes
  • Get a minimum of one thumbs worth of review, preferably two if enough team members are available
  • Get PO sign-off for all non-trivial UI or workflow changes
  • Verify all tests go green
  • Test this change deployed correctly and works on dev environment after deployment

@rushtong rushtong marked this pull request as ready for review December 3, 2025 20:57
@rushtong rushtong requested a review from a team as a code owner December 3, 2025 20:57
@rushtong rushtong requested review from kevinmarete and otchet-broad and removed request for a team December 3, 2025 20:57
Copy link
Contributor

@otchet-broad otchet-broad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Left one thought about the OpenAPI docs that is implementer's choice. Everything else looks good!
Thank you!

@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 4, 2025

@rushtong rushtong merged commit 89d46ba into develop Dec 4, 2025
15 of 17 checks passed
@rushtong rushtong deleted the gr-DT-2519-patch-study-api branch December 4, 2025 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants