Document media upload flows - #2633
Conversation
|
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 941e194 | Aug 25 2026, 03:02 PM |
@emdash-cms/admin
@emdash-cms/auth
@emdash-cms/auth-atproto
@emdash-cms/blocks
@emdash-cms/cloudflare
@emdash-cms/contentful-to-portable-text
emdash
create-emdash
@emdash-cms/gutenberg-to-portable-text
@emdash-cms/plugin-cli
@emdash-cms/plugin-types
@emdash-cms/registry-client
@emdash-cms/registry-lexicons
@emdash-cms/registry-verification
@emdash-cms/sandbox-workerd
@emdash-cms/x402
@emdash-cms/plugin-ai-moderation
@emdash-cms/plugin-atproto
@emdash-cms/plugin-audit-log
@emdash-cms/plugin-color
@emdash-cms/plugin-embeds
@emdash-cms/plugin-field-kit
@emdash-cms/plugin-forms
@emdash-cms/plugin-webhook-notifier
commit: |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
emdash-demo-do | 1085034 | Aug 25 2026, 04:53 PM |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
emdash-demo-cache | 1085034 | Aug 25 2026, 04:53 PM |
![emdashbot[bot]](https://avatars.githubusercontent.com/in/3255304?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR does the right thing: the existing public media upload docs were stale (JSON metadata endpoint, signed-URL-only narrative, 10 MB default), and the rewrite lines up with the current implementation. I checked the changed prose against the route handlers, storage adapters, schemas, authorization middleware, admin media UI, and the integration/openapi tests. The technical claims hold up: the 50 MB default, the two upload paths, the same-origin fallback for local/R2 storage, the media:write token scope, the optional multipart fields, the pending/ready lifecycle, the deduplication response, and the error statuses all match the code.
Only one small documentation issue surfaced: the new ### Create media heading is sentence case while every other media endpoint heading (List Media, Get Media, Update Media, Delete Media) is title case. That inconsistency makes the reference harder to scan. Fixing it keeps the page consistent without changing meaning.
No changeset is needed (docs-only change), and I saw no AGENTS.md convention violations.
Co-authored-by: emdashbot[bot] <273199577+emdashbot[bot]@users.noreply.github.com>
github-actions
Bot
added
the
review/needs-rereview
github-actions
Bot
added
review/approved
2 participants
What does this PR do?
Corrects the public media upload documentation so it matches the current REST API and Media Library.
This PR changes documentation only. It does not change runtime or admin behavior.
Related issue: None.
Type of change
Checklist
pnpm typecheckpassespnpm lintpassespnpm testpasses (or targeted tests for my change)pnpm formathas been runAI-generated code disclosure
Screenshots / test output
pnpm typecheckpnpm lintpnpm formatpnpm --dir docs buildpnpm --dir packages/core exec vitest run tests/integration/astro/media-stream-upload.test.ts— 30 tests passedpnpm --dir packages/core exec vitest run tests/unit/api/openapi.test.ts tests/unit/media/media-allowlist.test.ts— 30 tests passed