Skip to content

[docs] Update interaction file upload docs for GetFiles() and upload limits - #1554

Merged
James Newton-King (JamesNK) merged 5 commits into
release/17.0from
docs/pr-19488-32349097745-1-440da2a5711588ec
Aug 20, 2026
Merged

[docs] Update interaction file upload docs for GetFiles() and upload limits#1554
James Newton-King (JamesNK) merged 5 commits into
release/17.0from
docs/pr-19488-32349097745-1-440da2a5711588ec

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#19488

@JamesNK

Targeting release/17.0 — the latest release branch on microsoft/aspire.dev — because release/13.6 (from the source PR milestone 13.6) does not exist there.

Why

The source PR hardens interaction file uploads and changes the public API used to read uploaded files:

  • Adds InteractionInput.GetFiles(), returning a new disposable InteractionFileCollection.
  • Marks InteractionInput.Files [Obsolete] in favor of GetFiles().
  • Disposing the collection deletes the uploaded temporary files from disk; after disposal, InteractionFile.OpenRead()/ReadAllBytesAsync() throw ObjectDisposedException, though already-open streams remain usable until disposed.
  • Adds a shared maximum of 100 files for inputs with AllowMultipleFiles = true (1 file otherwise), enforced during upload with in-progress uploads counted as reserved slots.

The existing extensibility/interaction-service.mdx "Prompt for file upload" section used the old result.Data.Files?[0] pattern and didn't mention the new ownership/disposal model or the file-count limit, so it no longer matched the shipped API.

Changes

  • src/frontend/src/content/docs/extensibility/interaction-service.mdx:
    • Updated the C# example to use using var files = result.Data.GetFiles(); instead of the obsolete Files property.
    • Added a paragraph explaining GetFiles() ownership/disposal semantics and that Files is obsolete.
    • Updated the AllowMultipleFiles bullet to document the 100-file limit (1 file when not multi-file) and that in-progress uploads count toward it.

Only this existing page was updated; no new pages were created.

Generated by PR Documentation Check for #19488 · auto · 63.7 AIC · ⌖ 12.7 AIC · ⊞ 19.6K ·

… limit

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Aug 20, 2026
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1554. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1554 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
@JamesNK
James Newton-King (JamesNK) marked this pull request as ready for review August 20, 2026 09:16
Copilot AI lite review requested due to automatic review settings August 20, 2026 09:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Interaction Service documentation to reflect the new file-upload API patterns and lifecycle semantics introduced in microsoft/aspire (moving from InteractionInput.Files to GetFiles() and documenting temporary-file cleanup expectations).

Changes:

  • Updated the C# file-upload example to use InteractionInput.GetFiles() and index into the returned collection.
  • Added guidance about temporary file ownership/disposal for C# and release semantics for TypeScript (releaseFiles() in a finally block).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx
@JamesNK
James Newton-King (JamesNK) merged commit 29946e7 into release/17.0 Aug 20, 2026
11 checks passed
@JamesNK
James Newton-King (JamesNK) deleted the docs/pr-19488-32349097745-1-440da2a5711588ec branch August 20, 2026 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants