docs: add Assets vs Files comparison guide (supersedes #806)#1308
docs: add Assets vs Files comparison guide (supersedes #806)#1308lin-bot23 wants to merge 1 commit into
Conversation
This guide clarifies the distinction between the Assets API and File API, covering upload methods, deduplication behavior, and URL-based source requirements. Supersedes PR Comfy-Org#806, with the following fixes: - Added Mintlify frontmatter (title, description) - Registered in docs.json under development/cloud/ - Replaced em dashes with colons/hyphens - Wrapped ASCII decision tree in text fence - Fixed broken curl quoting (missing closing quote on header) - Removed speculative URL source requirements; use conservative wording - Removed unverified "Using Assets as Workflow Inputs" section; replaced with Info note linking issue Comfy-Org#754 - Changed blockquote recommendation to Mintlify Note component - Removed redundant --- section separators
|
Warning Review limit reached
Next review available in: 43 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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 |
Implements a new guide clarifying the distinction between Comfy Cloud Assets API (
/api/assets) and File API (/api/upload/image).Responds to feedback on PR #806 from @DialloWill.
Summary
development/cloud/assets-vs-files.mdxdocs.jsonunder Cloud API groupFixes relative to #806
titleanddescriptionconsistent with sibling pagesdevelopment/cloud/(Cloud API Reference tab is auto-generated from OpenAPI spec, cannot host manual MDX pages)X-API-Key: ***"header (both examples)https://" to neutral "The URL must be reachable by Comfy Cloud servers"; OpenAPI spec saysformat: uri/ "HTTP/HTTPS URL"<Info>note linking issue Issue on docs - (Comfy Cloud API) Clarify "Asset" vs "File" endpoints and document supported sources for URL-based uploads #754> **Recommendation:**to Mintlify<Note>component---horizontal rulesSource
openapi-cloud.yaml(POST /api/assets, error codes)Checklist
development/cloud/assets-vs-files.mdx(new) anddocs.json(modified)