10

While troubleshooting /posts/{id}/comments/add in order to answer Why am I getting a 404 when trying to post a comment?, it was noticed that the API path in question only responded to POST requests. This is all well and good, especially given that adding a comment is neither idempotent nor safe, which GETs should be (HTTP spec says so). However, there is just one problem:

Nowhere in the documentation is it mentioned that you need to use POST to successfully write.

Knowledge of the HTTP spec (and super deductive skills) told me and commenter Brock Adams the correct remedy ("You need to POST, not GET."), but I really think this should be documented.

3
  • 1
    As you know, I have additional concerns about the documentation of the API
    – Besi
    Mar 4, 2014 at 9:21
  • 3
    it's 2017 now, and nothing changed.
    – cweiske
    May 12, 2017 at 18:53
  • And now it's 2018 and the documentation still doesn't mention it. SE: Seriously, how hard is it to change/add a small amount of text, so the people you're wanting to have make things which make you more money don't have to waste their time figuring this out? Admittedly, it was the one of the first possibilities that came to mind, based on the somewhat cryptic error message, but it wasn't the first thing I checked, because it wasn't mentioned in the documentation, and surely they'd state something so basic in the documentation.
    – Makyen
    Apr 19, 2018 at 6:47

0

You must log in to answer this question.

Browse other questions tagged .