Storage-object deposit model: the registered deposit extension#32
Open
johnf wants to merge 4 commits into
Open
Storage-object deposit model: the registered deposit extension#32johnf wants to merge 4 commits into
johnf wants to merge 4 commits into
Conversation
This was referenced Jul 21, 2026
Closed
Adds the deposit extension to the spec: deposit sessions (create/stage/ finalise/abort), the storage-object read surface, crate-as-manifest carry-forward for updates, deletion with a per-implementation tombstone policy, catalog↔storage-object linkage fields, the DepositCapability declaration, and the OAuth2 write scope. Bumps the spec to 0.3.0. Implements the decisions on the wayfinder map #22 (tickets #23–#28). Part of #29.
Adds an 'Extension: deposit' section under Extensions: the model page (storage objects, materialisation contract with PARADISEC/LDaCA examples, capability declaration, visibility patterns), the deposit-session walkthrough (both upload modes, sync/async finalise, failure handling), the carry-forward update flow, and deletion/lifecycle (tombstones, curation storage objects, constrained entity delete). Registers the extension in the registry table and refreshes capability examples.
johnf
marked this pull request as ready for review
July 21, 2026 09:45
johnf
force-pushed
the
deposit-extension-spec
branch
from
July 23, 2026 04:53
fd92448 to
0ee1fe7
Compare
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.
Summary
Adds the storage-object deposit model as a registered extension (
deposit) — the API's first write pathway. Spec bumped to 0.3.0 (openapi.yaml+CHANGELOG.md) with a new docs subcategory (docs/extensions/deposit/).This supersedes the v1 read–write discussion paper's entity-granular writes, which the Technology Committee pushed back on because one crate spans many entities. Charted and decided on the wayfinder map Map: Storage-object deposit model.
The model
POST /deposits(create) orPOST /storage-object/{id}/deposits(update) → stage crate and files (PUT /deposit/{id}/crate,PUT /deposit/{id}/file/{fileId}, inline or presigned) →POST /deposit/{id}/finalise(sync200or async202; validation failure returns the deposit toopen).storageObjectIdson Entity,entityIdson StorageObject, optionalstorageObjectIdon File).@id→ permitted-dangling. Last finalise wins as a unit, with an optional stale-finalise409.GET /storage-objects, leanGET /storage-object/{id},GET /storage-object/{id}/cratereturning the deposited crate verbatim;/entity/{id}/rocratere-specced as implementation-defined provenance (stored or virtualised) but always a valid RO-Crate.DELETE /storage-object/{id}(implementation-defined409-with-reason), constrainedDELETE /entity/{id}for contributor-less entities only, one410/404tombstone policy per implementation with aTombstoneschema.capabilities.extensions.deposit— requiredidMinting,fileUpload,tombstonePolicy; optionaldepositTtlSeconds,maxFileSizeBytes. Auth is a new coarse OAuth2writescope.Docs
An "Extension: deposit" sidebar subcategory: the extension guide (model, materialisation worked examples, capability field guidance, both visibility patterns) plus three flow pages — Depositing, Updating a Storage Object, and Deletion & Lifecycle. Extension registry table and capability examples updated.
Key decisions
Open points for the committee
deposit(mandatory / core-but-optional / extension — drafted as an extension) — being socialised on Slack.Verification
pnpm lint(tsc, Biome, Redocly) and the full Docusaurus build (onBrokenLinks: 'throw') pass.