alphagov / alphagov/support-api
Feature request: Creating a Zendesk ticket should take optional `html_body`
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 7
- Forks
- 5
- Avg merge
- 23h 1m
- Merged PRs (30d)
- 9
Description
Support API currently hardcodes a body attribute.
However, this doesn't support sending code blocks and suchlike:
Markdown formatting is supported in body but not in html_body. Markdown formatting in body renders only if the comment author is an agent. To format end user comments, use html_body and HTML.
Instead, we would need to send html_body and swap out triple-backticks for <pre>. But we can't do that until Support API allows us to (optionally) send a html_body instead of a body.
See Slack thread.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with app/models/support_ticket.rb at the hardcoded body attribute and trace how the ticket payload is built. Check the Zendesk ticket comment API requirements linked in the issue, then verify that an optional html_body can be sent instead of body while retaining the existing behavior when it is absent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100