SparkPost / SparkPost/developers.sparkpost.com
Mention where the transmission description is displayed
Open
Nobody has claimed this yet.
- Dominant language
- API Blueprint
- Stars
- 18
- Forks
- 9
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 3
Description
At https://developers.sparkpost.com/api/transmissions/#header-request-body, how exactly is the field description used? I set it to a relevant value, but I don't see that at https://app.sparkpost.com/reports/message-events/details/....
Contributor guide
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 at the transmissions API documentation section linked in the issue and trace the description field's documented behavior to the message-events details page. Confirm where the value is displayed, then update the documentation so the field's destination or limitation is explicit.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100