docs: document one verb per status endpoint - #35
Merged
Merged
Conversation
The reference noted that change_state also accepts GET and that list_states also accepts POST. Both routes do accept the second verb, but documenting it reads as an endorsement: a GET that mutates an answer's status is what we do not want integrations to build. Each endpoint now shows a single verb, the one its purpose calls for: POST for the status change, GET for the lookup. The routes are unchanged, so existing integrations keep working either way. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #34.
Why
That PR noted, for each of the two status endpoints, that the other verb also works:
change_state: "GETis also accepted, with the same parameters."list_states: "POSTis also accepted. The endpoint takes no parameters either way."Both statements are true of the routes, but stating them in the reference reads as an endorsement. A
GETthat mutates the status of an answer is exactly the shape we do not want integrations to build, and it is the kind of call that gets retried by a crawler, a prefetch or a link preview.What changed
Each endpoint now documents the single verb its purpose calls for:
POSTfor the status change,GETfor the lookup. Onlist_statesthe useful half of the sentence is kept as "The endpoint takes no parameters."The routes themselves are untouched, so anything already calling either verb keeps working. Two lines changed, nothing else.
No changelog entry: the
10-Sep-2026entry that announced these endpoints never mentioned verbs, so it stays accurate as is.🤖 Generated with Claude Code