docs: clipping in the Public API and CLI - #252
Merged
Merged
Conversation
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
✅ 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. |
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (8)
✨ 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 |
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.
What kind of change does this PR introduce?
Docs (Public API, CLI, clipping guide). Adds
POST /clipping,GET /clippingandGET /clipping/{id}with a Clipping tag andClippingRequest/Clipping/ClippingSummary/ClippingClipschemas topublic-api/openapi.json, the pagespublic-api/clipping/{create,get,list}.mdxandcli/clipping.mdx, and both in thedocs.jsonnavigation.cli/introduction.mdxlists the threeclipping:*commands, and ingeneral/clipping.mdxthe "Not in the Public API or CLI" section becomes "From the Public API and the CLI". The create page documents the clipping minutes (402, when they are charged and refunded), the429caps, and that polling is not counted by the hourly rate limit. MCP and plan pages are unchanged.Why was this change needed?
Clipping gets Public API endpoints (gitroomhq/postiz-app, branch
feat/clipping-public-api) and CLI commands (gitroomhq/postiz-agent, branchfeat/clipping), and the guide said explicitly that neither existed.Other information:
Merge once the postiz-app PR is deployed and CLI 2.0.19 is published, otherwise the docs describe endpoints that answer 404.
QA
npx mint devin the repo; expect it to start without navigation or OpenAPI errors402,406,429and503responses and the Clipping minutes sectionclipping:*rows in the Commands Overview of the CLI introduction/public-api/clipping/createand/cli/clippingnpx mint broken-links; expect no broken links🤖 Generated with Claude Code
Summary by CodeRabbit