Document WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161
Open
IEvangelist with Copilot wants to merge 2 commits into
Open
Document WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161IEvangelist with Copilot wants to merge 2 commits into
WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3#1161IEvangelist with Copilot wants to merge 2 commits into
Conversation
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document command return values in migration summary
Document Jun 2, 2026
WithCommand return-value payloads (Text/Json/Markdown) for Aspire 13.3
Contributor
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.
| </Tabs> | ||
|
|
||
| ## Return structured output from a command | ||
| ## Returning a result from a command |
| ### Resource commands return structured results | ||
|
|
||
| Custom resource commands can now return an `ExecuteCommandResult` with a structured `Message` payload that the dashboard renders in the notification center. The new `Logger` property on `ExecuteCommandContext` lets command implementations log directly to the resource's log stream. | ||
| Custom resource commands can now return an `ExecuteCommandResult` with structured `Data` payloads (`Text`, `Json`, or `Markdown`) that the dashboard renders from the notification center's **View response** action. The `CommandResults.Success(string, CommandResultData)` overload also makes it easy to return markdown tables and other rich output from a command. The new `Logger` property on `ExecuteCommandContext` lets command implementations log directly to the resource's log stream. |
|
|
||
| <Image src={notificationCenterResponse} alt="Aspire dashboard text visualizer showing a command response opened from the notification center." /> | ||
|
|
||
| Markdown command results render as formatted Markdown in the text visualizer (for example, headings and tables), not as raw markdown source. |
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.
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.