Skip to content

docs(api): update JSON-RPC response examples - #97

Merged
fguillot merged 1 commit into
kanboard:mainfrom
pysocrates:fix/task-metadata-response
Nov 12, 2026
Merged

fguillot merged 1 commit into
kanboard:mainfrom
pysocrates:fix/task-metadata-response

Conversation

@pysocrates

Copy link
Copy Markdown
Contributor

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 getTaskMetadata to 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

  • Compared the structure and JSON types of the 13 refreshed examples with responses from a local PostgreSQL-backed Kanboard instance.
  • Verified empty and populated task metadata on PostgreSQL and SQLite; confirmed that is_active is a boolean on PostgreSQL and an integer on SQLite in the tested environments.
  • Verified missing-task results for getTask, getAllComments, and getAllTaskFiles using the application API token on PostgreSQL.
  • Parsed all 162 JSON examples in the changed files and built the documentation with Hugo 0.105.0 using the CI build options.

@fguillot
fguillot merged commit 54784b5 into kanboard:main Nov 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants