Skip to content

Conversation

@rushtong
Copy link
Contributor

@rushtong rushtong commented Dec 11, 2024

Addresses

Partially addresses https://broadworkbench.atlassian.net/browse/DT-982

Summary

This PR refactors the model classes used for submitting Zendesk tickets. Future PRs will introduce more functionality such as adding API endpoints and real file uploads.

  • Whenever possible, classes are converted to records.
  • This adds uploads to the comments model. Actual file uploads is not yet supported, but this allows for them to be specified in the request itself.
  • While we're here, add the API docs for the yaml. SupportTicket.yaml corresponds to what is currently sent via the UI as an entity. SupportTicketResponse.yaml is the exact format Zendesk returns after a POST operation.

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

Base automatically changed from gr-DT-982-cleanup to develop December 11, 2024 19:00
# Conflicts:
#	src/test/java/org/broadinstitute/consent/http/service/SupportRequestServiceTest.java
@rushtong rushtong marked this pull request as ready for review December 11, 2024 19:48
@rushtong rushtong requested a review from a team as a code owner December 11, 2024 19:48
@rushtong rushtong requested review from rjohanek and s-rubenstein and removed request for a team December 11, 2024 19:48
Copy link
Member

@pshapiro4broad pshapiro4broad left a comment

Choose a reason for hiding this comment

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

Looks OK, just a few comments

Copy link
Contributor

@rjohanek rjohanek left a comment

Choose a reason for hiding this comment

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

refactor looks good!

@rushtong rushtong merged commit 7eff74e into develop Dec 12, 2024
14 checks passed
@rushtong rushtong deleted the gr-DT-982-models branch December 12, 2024 20:57
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