Repository navigation
docs(api): update JSON-RPC response examples - #97
Merged
Merged
Conversation
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
Several JSON-RPC response examples show strings for values that current Kanboard installations may return as numbers or booleans. Refresh 13 examples using responses from Kanboard 1.2.54 with PostgreSQL 17 and PHP 8.4, and identify the environment used for those examples.
Correct
getTaskMetadatato show an object (including an empty object when no metadata exists), document empty results for comment and task-file lists, remove obsolete project calendar URLs, and note that response types and fields can vary by environment.Related to kanboard/kanboard#5907. Other API examples and MySQL behavior have not been fully audited.
Validation
is_activeis a boolean on PostgreSQL and an integer on SQLite in the tested environments.getTask,getAllComments, andgetAllTaskFilesusing the application API token on PostgreSQL.