SparkPost / SparkPost/developers.sparkpost.com

Create or Update a Suppression documented response doesn't match actual response

Open
#559 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
API Blueprint
Stars
18
Forks
9
Avg merge
2d 1h
Merged PRs (30d)
3

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.