[docs] Add interaction service support for polyglot app hosts#1248
Draft
aspire-repo-bot[bot] wants to merge 2 commits into
Draft
[docs] Add interaction service support for polyglot app hosts#1248aspire-repo-bot[bot] wants to merge 2 commits into
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
Document the IInteractionService API now available in TypeScript (and other polyglot) app hosts via microsoft/aspire#17959. - Remove outdated note stating the API was unavailable in TypeScript - Add introductory sentence noting polyglot app host support - Add 'TypeScript app hosts' section covering: - Resolving the service via ctx.serviceProvider().getInteractionService() - Availability check with isAvailable() - Message-style prompts (promptConfirmation, promptMessageBox, promptNotification) - Input factory methods (createTextInput, createSecretInput, etc.) - Single and multi-input prompts with result handle access - Dynamic loading via withDynamicLoading and loadContext - Validation callback on the options object - Add multi-language architecture cross-reference to See also Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
3 tasks
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
1 participant
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.
Documents changes from microsoft/aspire#17959 —
@sebastienrosTargeting
release/13.5based on the source PR milestone13.5(exact match onmicrosoft/aspire.dev).Why this PR is needed
PR #17959 exposed
IInteractionServiceto polyglot app hosts (TypeScript, Python, Go, Java, and Rust) via the ATS/JSON-RPC surface. The existing interaction service documentation onmicrosoft/aspire.devcontained an explicit<Aside type="note">stating:That statement is now incorrect, and users following the docs would not know the API exists or how to use it.
What was changed
Updated
src/frontend/src/content/docs/extensibility/interaction-service.mdx:## TypeScript app hostssection documenting:ctx.serviceProvider().getInteractionService()isAvailable()promptConfirmation,promptMessageBox,promptNotification)createTextInput,createSecretInput,createBooleanInput,createNumberInput,createChoiceInput) with builder chaining (.withValue(),.withChoiceOptions())promptInput,promptInputs) with result-handle access (result.canceled(),result.inputs().value(name))withDynamicLoadingand theloadContextpatternvalidationContextFiles modified
src/frontend/src/content/docs/extensibility/interaction-service.mdx(updated)