Document the error field on listed posts (public API)

[giladresisi]

⚠️ Do not merge until gitroomhq/postiz-app#1868 is deployed

This documents a field the API only returns once that PR's backend change is live.

Adds an error property (string, nullable) to the Post schema used by GET /posts in the public API OpenAPI spec. For posts in the ERROR state it holds the error message reported by the platform when it rejected the post (the same message shown in the calendar tooltip), and null when the post did not fail or no curated platform message is available.

Tested locally with mintlify dev: the List Posts page renders the new posts.error field and the response example correctly, with no layout overflow (long example message wraps in the field docs and scrolls within the code block).

🤖 Generated with Claude Code

https://claude.ai/code/session_01XvHgEEangtx46CmTGCrnL1

Summary by CodeRabbit

• New Features
  • Added an optional error message to post details when a post fails and enters an error state.
  • API documentation now includes an example of the error response.

[postiz-agent]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d2b6c07e-6e21-486d-ae59-e77328f53067

📥 Commits

Reviewing files that changed from the base of the PR and between 227f80e and dbb6d06.

📒 Files selected for processing (1)

• public-api/openapi.json

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The public OpenAPI Post schema now includes a nullable error field. The field documents platform rejection messages for posts in the ERROR state and returns null when no error applies.

Changes

Post error response contract

Layer / File(s)	Summary
Post schema error property public-api/openapi.json	The Post schema adds a nullable string error property with documentation and an example for platform failure messages.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to dbb6d

This localized change documents the nullable error field returned by the public posts API. No actionable merge-blocking risk remains beyond normal review and the stated backend deployment sequencing.

Suggested reviewers: egelhaus, nevo-david

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: documenting the error field for posts in the public API.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/public-api-post-error

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}