Update support tickets endpoint part1 #991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was causing an error
GdsApi::HTTPUnprocessableEntity: URL: http://support-api/support-tickets
Response body:
{"status":"error","errors":{"description":["can't be blank"]}}
The docs say to use `comment` instead.
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#description-and-first-comment
"When creating a ticket, use the comment property to set the ticket description, which is also the first comment.
Important: Do not use the description property to set the first comment. The property is for reading purposes only. While it's possible to use the property to set the first comment, the functionality has limitations and is provided to support existing implementations."
Ticket Comments are represented as JSON objects. They have a multiple properties.
The comment string needs to be in the "body" property.
See https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
We anticipate that the inbound API call will have the body formatted so we don't need to do it here. `user_agent` attribute should also be removed from support_tickets_controller. Since it requires update to the Pact test in a another repo it will be removed in a follow up PR.
AgaDufrat
force-pushed
the
update-support-tickets-endpoint-part1
branch
from
8d5397c to
029d633
Compare
deborahchua
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
user_agent, if necessary it will be in the bodySee commit messages for details. Tested in integration. This endpoint is not currently used.
Zendesk API reference: https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
alphagov/support#1422
Follow these steps if you are doing a Rails upgrade.