Create or Update a Suppression documented response doesn't match actual response
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start at content/api/suppression-list.apib around line 104 and compare the documented 200 response with the actual response shown in the issue. Check related suppression endpoint examples for the same mismatch, then update the documentation where needed so the response shape matches reality.
Written by the indexing model from the issue text.
Description
The documentation for the Create or Update a Suppression endpoint has the following 200 response example:
{
"results": {
"message": "Suppression List successfully updated"
}
}
However, the actual response received is:
{
"results": "Suppression List successfully updated"
}
Did this change at some point? Is the documentation out of date? Is other related documentation possibly inaccurate as well?
- Dominant language
- API Blueprint
- Stars
- 18
- Forks
- 9
- Avg merge
- 2d 5m
- Merged PRs (30d)
- 8
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from SparkPost/developers.sparkpost.com
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
SparkPost/developers.sparkpost.com#501 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 32/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
All issues in SparkPost/developers.sparkpost.com
Similar issues
-
Docs: refresh target-app-parity and file-format-parity against mainPossibly taken @vangel76 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
storytold/photocraft#4417 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation help wanted needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 75/100
hivecommons/hive#11606 · 2 comments ·
Maintainers usually reply within 1 day
-
documentation good first issue launch
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
FlologixAI/etchwork#4 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
appsmithorg/appsmith-docs#3064 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
gravitational/teleport#69869 ·