Skip to content

docs(FIL-5): comprehensive S3 compatibility matrix#2

Open
RichardHerold wants to merge 1 commit intomainfrom
fil-5-s3-compatibility-matrix
Open

docs(FIL-5): comprehensive S3 compatibility matrix#2
RichardHerold wants to merge 1 commit intomainfrom
fil-5-s3-compatibility-matrix

Conversation

@RichardHerold
Copy link
Copy Markdown
Collaborator

Summary

Completes FIL-5 — publish S3 compatibility matrix and API reference.

Changes

docs/reference/s3-compatibility.mdx — full rewrite to cover all required categories:

  • Bucket operations — added GetBucketVersioning, PutBucketVersioning (partial), GetBucketObjectLockConfiguration, PutBucketObjectLockConfiguration, GetBucketEncryption, PutBucketEncryption (no-op), and all unsupported ACL/policy/lifecycle/notification/tagging operations
  • Object operations — added DeleteObjects, ListObjectVersions, versioned GetObject/DeleteObject/CopyObject, Object Lock retention ops, and all unsupported ACL/tagging/restore ops
  • Multipart upload — added ListParts and ListMultipartUploads
  • Versioning (new section) — always-on versioning documented with all related operations
  • Object Lock (new section) — Compliance mode support documented; Governance/Legal Hold marked as planned
  • Server-side encryption (new section) — always-on AES-256 SSE-KMS documented
  • ACLs (new section) — explicitly documented as not supported with SDK flag behaviour
  • Not yet supported — expanded to include notifications, tagging, Governance mode, multi-region, IAM
  • Differences from AWS S3 — expanded table covering versioning, encryption, ACLs, lifecycle, Object Lock modes, Filecoin data-retention behaviour

sidebars.js — added storage/versioning and storage/object-lock (both pages existed but were orphaned from the sidebar).

Acceptance criteria met

  • ✅ Developer can find in <30 seconds whether a specific S3 operation is supported
  • ✅ No ambiguity about missing vs planned features — every gap is explicitly marked
  • ✅ All categories covered: bucket ops, object ops, multipart, ACLs, versioning, lifecycle, notifications, presigned URLs, server-side encryption

- Expand s3-compatibility.mdx to cover all S3 API operation categories:
  bucket ops, object ops, multipart, versioning, object lock, presigned
  URLs, server-side encryption, ACLs, lifecycle, and notifications
- Mark each operation as supported/partial/not-supported/not-planned with
  accurate notes based on actual product behaviour
- Document always-on versioning and Compliance-mode Object Lock operations
- Add Differences from AWS S3 table covering versioning, encryption, ACLs,
  lifecycle, storage classes, regions, and Filecoin data-retention behaviour
- Add versioning and object-lock pages to sidebars.js (were orphaned)

Co-Authored-By: Paperclip <[email protected]>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
filone-docs Ready Ready Preview, Comment Apr 4, 2026 10:23pm

Request Review

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.

1 participant