Document polyglot integration authoring patterns#1230
Merged
Conversation
Add ATS-first authoring guidance for Aspire integrations, including overload design, capability naming, DTO shapes, callbacks, service access, value catalogs, and analyzer validation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the multi-language integration authoring guide to incorporate ATS-first, “field-tested” guidance aimed at helping integration authors design C# hosting APIs that generate clean, usable SDKs (notably TypeScript).
Changes:
- Expanded the guide with ATS-first patterns for capability IDs, overload shaping, DTO/input design, callback contexts, and member expansion guidance.
- Updated examples and guidance around analyzer enablement, diagnostics (including
ASPIREEXPORT014), and[AspireValue]catalog constraints. - Refreshed TypeScript snippets to emphasize generated-shape validation and callback/service-provider usage.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx | Adds ATS-first authoring patterns and updates analyzer/value-catalog guidance and TypeScript examples. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 9
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Remove misleading awaits from synchronous generated TypeScript service examples and tighten guidance to consult generated signatures for service-provider APIs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sebastienros
approved these changes
Jun 8, 2026
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.
This updates the multi-language integration authoring guide with field-tested ATS authoring guidance from recent polyglot fixes, so integration authors can design APIs that work well for C# AppHosts and generated SDKs such as TypeScript.
Summary
MethodName, overload design, DTO/input shapes, ATS values, callbacks, member expansion, and generated module validation.ASPIREEXPORT014, XML doc comment guidance, and[AspireValue]scanner constraints.Validation
git diff --check.