fix(api): conditionally set citation encodingFormat based on text presence#579
Merged
corinagum merged 2 commits intoJun 4, 2026
Merged
Conversation
The encodingFormat field must be present only when citation text is provided, otherwise Teams API returns a BadSyntax error.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes citation payload construction so encodingFormat is only populated when citation text is present, avoiding Teams API BadSyntax responses for citations without adaptive card text.
Changes:
- Conditionally sets citation
encodingFormatbased onappearance.text. - Updates
addCitationtests to cover text/no-text behavior and icon handling.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
packages/api/src/activities/activity.ts |
Updates citation appearance construction to avoid setting encodingFormat without text. |
packages/api/src/activities/activity.spec.ts |
Adjusts and expands addCitation test cases for encoding format behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chonlaphoom
changed the title
corinagum
approved these changes
Jun 4, 2026
corinagum
added a commit
that referenced
this pull request
Jun 15, 2026
## Release 2.0.13 Merges main into release for stable publish. ### Notable changes since 2.0.12 - fix(client): use explicit Graph scopes for Teams Desktop NAA compatibility (#616) - ci: switch publish pipeline to 1ES Official template for CodeQL/SDL (#607) - ci: add weekly SDL pipeline for CodeQL/CredScan compliance (#608) - Refresh teams.apps README (#604) - Reject unauthenticated when no credentials (#506) - fix(api): conditionally set citation encodingFormat based on text presence (#579) - Improvements to the Teams MCP server example (#597) - Bump MSAL Node to v5 (#603) - Merge root message entities in Activity (#590) - TeamsSDK: Correct imports and return types in misc. packages (#589) - Cache federated identity MSAL clients (#613) ### Release steps 1. Merge this PR 2. Trigger the [release pipeline](https://dev.azure.com/DomoreexpGithub/Github_Pipelines/_build?definitionId=52&_a=summary) for `release` branch with **Public** publish type 3. Bump version on main to `2.0.14-preview.{height}` 4. Create git tag and GitHub Release page
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.
While following the citations example (https://microsoft.github.io/teams-sdk/typescript/in-depth-guides/ai/best-practices) (which calls addCitation without text), I encountered a BadSyntax error: citation.appearance.text and citation.appearance.encodingFormat must either both be empty or both have values. This happens because encodingFormat was unconditionally set to 'application/vnd.microsoft.card.adaptive', even when text was omitted
Summary
Fixes
BadSyntaxerror whenaddCitationis called withouttext.Problem
Calling
addCitation(position, appearance)withoutappearance.textcauses a 400 error:The root cause:
encodingFormatwas hardcoded to'application/vnd.microsoft.card.adaptive'unconditionally, but the Teams API requires it to be absent whentextis absent.Fix
Changed
encodingFormatto be set only whenappearance.textis truthy: