docs(tiktok): document which settings apply per posting method and media type - #231
Merged
Conversation
UPLOAD sends the media to the user's TikTok app inbox (SEND_TO_USER_INBOX), where it must be finished manually within 24h or it is discarded. The API still reports the post as successful, so callers had no way to know. The enum was documented as "Upload for manual posting", which reads like a routine choice. Describe the consequence in providers/tiktok.mdx and add a matching description to the TikTokSettings schema in openapi.json (hand-maintained, not generated). Field stays required; enum unchanged. Also retitle the "Private Video (Draft)" example, which paired UPLOAD with privacy_level SELF_ONLY and so taught that UPLOAD is how you make a draft. The two are unrelated: SELF_ONLY publishes a video only you can see, while UPLOAD does not publish at all. It is now "Send to TikTok App Inbox (not published)" with PUBLIC_TO_EVERYONE, and notes how to get a private post. Mirrors gitroomhq/postiz-app#1687, which fixes the same bare enum in the agent @rules text and the TikTokDto schema.
…dia type TikTok settings vary along two axes that the docs never stated, so users ticked settings that TikTok silently discarded (e.g. "Video made with AI" on an UPLOAD post — TikTok's inbox upload endpoint accepts no post_info at all, only the title/content survives): 1. Posting method: every setting except the title requires content_posting_method=DIRECT_POST; UPLOAD keeps only the title. 2. Media type (within DIRECT_POST): duet, stitch and video_made_with_ai are video-only (photo post_info has no such fields); autoAddMusic is photo-only; privacy_level, comment and the brand toggles apply to both. Annotate the settings table in public-api/providers/tiktok.mdx with both axes and mirror the per-field descriptions from postiz-app's TikTokDto into the TikTokSettings schema in openapi.json (hand-maintained; only descriptions added, no field or required-ness changes). Extend the content_posting_method description with the discard behavior. Also switch the "Send to TikTok App Inbox" example to a real "Private Video" one (SELF_ONLY + DIRECT_POST): it paired UPLOAD with settings TikTok drops, and the dead settings cannot simply be removed because the API still requires them. The prose now explains how to send to the inbox instead and that only the title survives there. Add matching one-line caveats to the CLI examples (platform-examples, media-upload), the settings tables in public-api/posts/create.mdx and public-api/introduction.mdx, and a "Posting settings" section on the user-facing provider page describing the collapsed panel in UPLOAD mode. Follows up on 5fb180e (UPLOAD-never-publishes warning) and mirrors gitroomhq/postiz-app#1728. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Contribution-checker quality warning Heuristics that flagged:
If this is a genuine contribution, please add detail to your PR description and tighten the diff scope before reviewers look at it. |
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughTikTok documentation and OpenAPI descriptions now clarify ChangesTikTok posting settings
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Collaborator
Author
|
Companion skill-docs change for the agent repo: gitroomhq/postiz-agent#10 (same two-axis guidance, applied to SKILL.md / PROVIDER_SETTINGS.md). Mirrors the app fix gitroomhq/postiz-app#1728. |
Collaborator
Author
|
Correction to my earlier link: the agent-repo companion was split into two stacked PRs — gitroomhq/postiz-agent#11 (posting method) and gitroomhq/postiz-agent#12 (media-type axes, mirrors app fix gitroomhq/postiz-app#1728). The earlier #10 was closed. |
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
2 participants
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.
Why
A production user ticked "Video made with AI" on a TikTok post using the UPLOAD content posting method and the label was silently dropped: TikTok's inbox upload endpoint accepts no
post_infoat all, so every Postiz setting except the title/content has nowhere to go. The app-side fix landed in gitroomhq/postiz-app#1728 (UI hides DIRECT_POST-only settings in UPLOAD mode,TikTokDtofields carry@JSONSchemadescriptions, provider@Rulesteach the agent the constraints) — this PR brings the docs in line with it.TikTok settings vary along two axes the docs never stated:
content_posting_method=UPLOAD, TikTok keeps only the title/content; all other settings requireDIRECT_POST. UPLOAD also never publishes: the media lands in the TikTok app inbox as a draft the user must finish within 24h, while the API still reports success.duet,stitch,video_made_with_aiare video-only (photopost_infohas no such fields);autoAddMusicis photo-only;privacy_level,commentand the brand toggles apply to both.What changed
public-api/providers/tiktok.mdx— warn that UPLOAD never publishes; annotate every settings-table row with when it applies (DIRECT_POSTonly / video-only / photo-only), with a legend noting UPLOAD-discarded fields are still required by the API. Replaced the "Private Video (Draft)" example, which paired UPLOAD with settings TikTok discards, with a real Private Video example (SELF_ONLY+DIRECT_POST); the prose explains how to target the inbox instead.public-api/openapi.json(hand-maintained) — per-fielddescriptions onTikTokSettingsmirroringtiktok.dto.tsfrom fix(tiktok): stop offering settings TikTok silently ignores postiz-app#1728, plus the discard behavior oncontent_posting_method. Descriptions only — no field, type, or required-ness changes; validated withJSON.parse.providers/tiktok.mdx— new "Posting settings" section: the settings panel collapses in UPLOAD mode (matching the #1728 UI), and which settings are video-/photo-specific.cli/platform-examples.mdx,cli/media-upload.mdx,public-api/posts/create.mdx,public-api/introduction.mdx— one-line caveats after each TikTok example/settings table.After this PR, no example anywhere combines UPLOAD with settings TikTok will discard (verified by grep).
Docs counterpart of gitroomhq/postiz-app#1728.
🤖 Generated with Claude Code
Summary by CodeRabbit
DIRECT_POSTvsUPLOADmodes affect whether media is published and which settings are honored.UPLOADsends to the TikTok inbox and silently discards all settings except basic post content/title.duet,stitch, AI-made video) and photo-only (auto add music) options, plus video/photo behavior for privacy, comments, and branded-content toggles.UPLOADworkflow, including the “success” messaging caveat.