Skip to content

Update from code changes: VFS public files and folders reference - #37

Open
mintlify[bot] wants to merge 3 commits into
mainfrom
mintlify/3e86d1a4
Open

Update from code changes: VFS public files and folders reference#37
mintlify[bot] wants to merge 3 commits into
mainfrom
mintlify/3e86d1a4

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Add a reference page covering the new anonymous publishing, folder ZIP downloads, and public browse surfaces in the IXO Virtual File System, plus the hidden/public flags and public share links exposed on authenticated tree and file listings.

Changes

  • New reference/vfs-public-files.mdx describing:
    • The publishing model (private by default, folder cascade, "public overrides hidden", write-gated).
    • The three public URL forms (/public/id/:id, /public/cid/:cid, /public/:namespace/:path), streaming behaviour, verification headers, and edge caching.
    • Folder ZIP downloads (authenticated /api/fs/folder/download and anonymous /public/folder/...), with pre-flight caps and 404/413 semantics.
    • Public namespace browsing (/public/list/:namespace, flat/tree views, keyset pagination, omitted owner DIDs).
    • Publishing setters on upload, PATCH /files/:id/public, and PUT /folders/public.
    • hidden / public flags and publicUrl surfaced on GET /api/fs/tree and GET /api/fs/files nodes so UIs can render badges and share links without a second lookup.
    • GET /api/fs/content?path= and MCP tools vfs_set_public and vfs_fetch.
    • Security posture (uniform 404, no enumeration, rate limiting, audit).
  • Added the new page to the Stack → Reference nav group in docs.json.

Context

Documents the public-publishing surface introduced by ixoworld/ixo-virtual-filesystem#5 and extended by ixoworld/ixo-virtual-filesystem#7.

Update history

  • Initial commit: added reference/vfs-public-files.mdx and nav entry documenting the publish/unpublish contract, three public URL forms, folder ZIP downloads, /public/list browse, publishing setters, GET /api/fs/content, vfs_set_public / vfs_fetch, and the security posture — covering ixoworld/ixo-virtual-filesystem#5.
  • Follow-up: documented hidden / public flags and publicUrl now returned on GET /api/fs/tree and GET /api/fs/files nodes — covering ixoworld/ixo-virtual-filesystem#7.

@mintlify
mintlify Bot requested a review from Michael-Ixo July 7, 2026 01:13
@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ixoworld 🟢 Ready View Preview Jul 7, 2026, 1:21 AM

@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Documented that authenticated VFS tree and file listings now surface hidden and public flags plus publicUrl on each node.

Source PRs

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants