Skip to content

docs: Update Post Settings endpoint + postSettingsTool - #233

Open
giladresisi wants to merge 2 commits into
feat/list-posts-docsfrom
feat/update-post-settings-docs
Open

docs: Update Post Settings endpoint + postSettingsTool#233
giladresisi wants to merge 2 commits into
feat/list-posts-docsfrom
feat/update-post-settings-docs

Conversation

@giladresisi

Copy link
Copy Markdown
Collaborator

Docs for the Update Post Settings changes. Complementary to postiz-app #1752 (feat/agent-update-posts).

Stacked PR — base is feat/list-posts-docs (#232), not main. Review/merge that one first; this diff shows only the update-post-settings changes on top of it.

Changes

  • public-api/openapi.json — add the PUT /posts/{id}/settings operation (modeled on PUT /posts/{id}/status): merges the given keys into a not-yet-published post's provider settings; content and publish date unchanged.
  • public-api/posts/settings.mdx — new OpenAPI-backed page (the "Update Post Settings" button under Posts).
  • docs.json — register the new page in the Posts nav group.
  • mcp/introduction.mdx — add postSettingsTool to the Available Tools table; bump the tool count to 11 (10 from the stacked List Posts PR + 1 here).
  • mcp/tools.mdx — add a ## postSettingsTool reference section.

Tool-count coordination

Count is 11 as stacked. If this lands independently of #232, reconcile the count and the shared mcp/* files at merge time.

Verification

  • openapi.json and docs.json validated as JSON.
  • Rendered locally with Mintlify (mint dev) — the new endpoint page appears under Posts and renders (route, request body, 200 response); MCP pages render without errors.
  • New/updated pages Claude-viewed in-browser and human-viewed.

Related: gitroomhq/postiz-app#1752

🤖 Generated with Claude Code

- openapi.json: add PUT /posts/{id}/settings operation (modeled on /posts/{id}/status)
- new page public-api/posts/settings.mdx + Posts nav entry in docs.json
- mcp: add postSettingsTool to Available Tools table + tools reference, bump count to 11

Stacked on top of feat/list-posts-docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@giladresisi
giladresisi requested a review from egelhaus as a code owner July 20, 2026 13:34
@postiz-contribution postiz-contribution Bot added the contribution:approved Approved contributor label Jul 20, 2026
@postiz-contribution

Copy link
Copy Markdown

Contribution-checker quality warning
Heuristic score: 7/100 (low). This is a non-blocking warning surfaced by the project's quality settings.

Heuristics that flagged:

  • Excessive inline code references: 16 inline refs (>3)
  • AI watermark phrase: Matched: "Generated with Claude Code"
  • Commit message too long: Longest: 429 chars
  • Excessive added comments: 6 added comment lines (ratio 0.06)

If this is a genuine contribution, please add detail to your PR description and tighten the diff scope before reviewers look at it.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ce43d4a1-2a20-4db1-a8cf-d248bfc6b216

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/update-post-settings-docs

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

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

@postiz-agent

postiz-agent Bot commented Jul 20, 2026

Copy link
Copy Markdown

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.

@giladresisi

Copy link
Copy Markdown
Collaborator Author

CLI counterpart: gitroomhq/postiz-agent#13 adds the posts:settings command. Backend endpoint: gitroomhq/postiz-app#1752.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution:approved Approved contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants