Skip to content

feat: uri docs#975

Merged
coodos merged 1 commit into
mainfrom
feat/file-docs
May 28, 2026
Merged

feat: uri docs#975
coodos merged 1 commit into
mainfrom
feat/file-docs

Conversation

@coodos

@coodos coodos commented May 28, 2026

Copy link
Copy Markdown
Contributor

Description of change

Add docs for uploadFile

Issue Number

Type of change

  • Docs (changes to the documentation)

How the change has been tested

Change checklist

  • I have ensured that the CI Checks pass locally
  • I have removed any unnecessary logic
  • My code is well documented
  • I have signed my commits
  • My code follows the pattern of the application
  • I have self reviewed my code

Summary by CodeRabbit

  • Documentation
    • Updated W3DS Protocol documentation with comprehensive specifications for file upload operations, including content constraints and requirements.
    • Added detailed guidance on URI resolution and clarified the relationship between protocol-level file envelopes and application-level file records.
    • Enhanced documentation on failure handling and cleanup semantics for file operations.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b9967abf-2cea-4b3e-9efa-43ece0773beb

📥 Commits

Reviewing files that changed from the base of the PR and between b89164b and f65c778.

📒 Files selected for processing (1)
  • docs/docs/W3DS Protocol/File-URIs.md

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation to the W3DS Protocol File-URIs specification. It introduces a complete uploadFile GraphQL mutation specification with request/response schemas, header requirements, storage configuration, content validation, and failure cleanup semantics. It also clarifies the distinction between the low-level w3ds-file-v1 envelope and the platform-level File ontology.

Changes

W3DS File-URIs Protocol Specification

Layer / File(s) Summary
uploadFile mutation specification
docs/docs/W3DS Protocol/File-URIs.md
Full mutation specification defining UploadFileInput/UploadFilePayload schemas, required X-ENAME header, object-storage configuration expectations, base64 validation, size limits, persisted w3ds-file-v1 envelope fields, and compensating cleanup to prevent orphaned objects on failure.
w3ds-file-v1 envelope vs File ontology clarification
docs/docs/W3DS Protocol/File-URIs.md
New section contrasting the low-level w3ds-file-v1 envelope (URI dereferencing) with the platform-level File ontology (UUID-based application records), explaining their identifier schemes, payload differences, layers, and when to use each for blob storage versus application modeling.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

📄 New specs bloom in markdown garden,
uploadFile's dance, with headers we pardon,
Envelopes and ontologies, distinct yet they play,
Where w3ds meets File in architectural ballet! 🐰✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/file-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coodos coodos merged commit 0cbf149 into main May 28, 2026
3 of 4 checks passed
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