Document WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161
Document WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161IEvangelist with Copilot wants to merge 1 commit into
WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161Conversation
WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3
There was a problem hiding this comment.
Pull request overview
This PR updates Aspire 13.3 documentation to describe the new “structured command result payloads” contract (Text/Json/Markdown), including how results flow into the dashboard notification center and how to return Markdown output from custom resource commands.
Changes:
- Updates the Aspire 13.3 “What’s new” entry to explicitly call out
ExecuteCommandResult.Datapayloads and Markdown-capable results. - Renames/reshapes the custom resource commands docs section to focus on returning structured results and adds a Markdown return example.
- Clarifies dashboard behavior for Markdown command results in the text visualizer and tightens cross-link wording.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/whats-new/aspire-13-3.mdx | Updates release-note wording to call out structured command payloads and the helper overload used to return them. |
| src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx | Renames the structured-output section and adds a Markdown return example for CommandResultData / CommandResultFormat.Markdown. |
| src/frontend/src/content/docs/dashboard/explore.mdx | Adds a note that Markdown results are rendered in the text visualizer and refines the link description to the commands docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Address review feedback: add TypeScript Markdown example, fix heading style, imp
8667b03 to
2275d76
Compare
|
Changed to release/13.5 because the sample includes TS which is new. |
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Aspire 13.3 added support for returning payload data from resource commands, including Markdown rendered in the dashboard response viewer. This PR updates the relevant docs to clearly describe the API contract, dashboard behavior, and release-note messaging.
Custom resource commands docs
CommandResultDatawithCommandResultFormat.Markdown.ExecuteCommandResult.Dataand result formats.Dashboard docs
13.3 changelog
Text,Json,Markdown) and theCommandResults.Success(string, CommandResultData)usage pattern.