docs(api): document request bodies, required params and status codes in REST reference - #188
Open
TimeToBuildBob wants to merge 1 commit into
Conversation
…in REST reference Git-Session-Id: 9fac
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.
The REST reference lists endpoint paths only. A watcher author following it hits avoidable failures, found by probing aw-server (Python) and aw-server-rust 0.13.2 with the same script:
POST .../heartbeatwithout?pulsetime=is rejected by both servers (400 on Python, an HTML 422 on Rust).POST .../eventsrequires a JSON list on Rust; Python also accepts a bare object. This mismatch is what broke aw-watcher-jetbrains (aw-server-rust#174)./query/, import/export, settings, event count and bucket delete (?force=1) were undocumented.This documents request bodies, parameters, status codes and the known Python/Rust differences (settings DELETE only on Rust, error behaviour, import into an existing bucket). Only behaviour observed in the probe is stated.