Repository navigation
docs: correct four statements checked against the client - #40
Merged
Merged
Conversation
- results: on a failed call getData() is null only when there is no JSON answer; when Proxmox VE answers with an error it is an empty node. - tasks: same wording for the UPID of a failed call; the interval and the time of waitForTaskToFinish have a lower limit. - API structure: required parameters are int and boolean, the optional ones Integer and Boolean.
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
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.
Summary
A check of the whole documentation against the client found four statements that were not exact. No code change.
concepts/results.mdx: "on a failed callgetData()isnull" was true only for a request without a JSON answer (status 0, 408, 502, or an empty body). When Proxmox VE answers with an error (400, 500, 501) the answer has"data": null, sogetData()is an empty node and it isget("name")on it that returnsnull.concepts/tasks.mdx: same wording where the UPID of a failed call is read.concepts/tasks.mdx:waitForTaskToFinishturns an interval of 0 or less into 500 ms, and a time shorter than the interval into the interval plus 5 seconds. It was not written.concepts/api-structure.mdx: "booleans areBoolean" was true only for the optional parameters. The required ones are primitive (int,boolean).How it was checked
loginreturnsfalse, status 401), no credentials (401), a task log withoutlimit(50 lines), a task that does not exist (PveResultException).npm run build: 14 pages.