Skip to content

Align ClientCitationIconName with Teams "Add citations" docs#387

Draft
MattB-msft with Copilot wants to merge 3 commits into
mainfrom
copilot/update-client-citation-icon-names
Draft

Align ClientCitationIconName with Teams "Add citations" docs#387
MattB-msft with Copilot wants to merge 3 commits into
mainfrom
copilot/update-client-citation-icon-names

Conversation

Copilot AI commented May 13, 2026

Copy link
Copy Markdown
Contributor

The ClientCitationIconName enum should mirror the predefined values for citation.appearance.image.name documented in the Teams Add citations article. All 21 documented names were already present, but the ordering diverged from the docs, the source of truth wasn't referenced, and there was no test pinning the list.

Changes

  • Reorder enum entries to match the docs verbatim (Source Code and Sketch now precede the Adobe group). String values are unchanged, so wire format is unaffected.
  • Docstring updated to cite the Teams "Add citations" docs URL.
  • New test test_client_citation_icon_name_matches_teams_docs pins the full set and order of allowed names, so future drift in the docs is caught.
class ClientCitationIconName(str, Enum):
    """Supported citation icon names for ``citation.appearance.image.name``.

    See "Add citations":
    https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content#add-citations
    """
    MICROSOFT_WORD = "Microsoft Word"
    # ...
    MICROSOFT_WHITEBOARD = "Microsoft Whiteboard"
    SOURCE_CODE = "Source Code"
    SKETCH = "Sketch"
    ADOBE_ILLUSTRATOR = "Adobe Illustrator"
    # ...

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • learn.microsoft.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested review from Copilot and removed request for Copilot May 13, 2026 00:43
Copilot AI changed the title [WIP] Update AI citations image names in ClientCitationIconName Align ClientCitationIconName with Teams "Add citations" docs May 13, 2026
Copilot AI requested a review from MattB-msft May 13, 2026 00:44
@MattB-msft MattB-msft requested a review from axelsrz May 13, 2026 01:01
Copilot AI review requested due to automatic review settings July 7, 2026 17:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aligns the ClientCitationIconName enum with the ordering and documented source-of-truth for Teams’ citation.appearance.image.name predefined values, and adds a regression test to prevent future drift.

Changes:

  • Reordered ClientCitationIconName members to match the Teams “Add citations” documentation order (string values unchanged).
  • Updated the enum docstring to cite the Teams documentation URL.
  • Added a test that pins both the exact set and ordering of allowed icon name values.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
tests/activity/entity/test_serialization.py Adds a test that asserts the full set and order of ClientCitationIconName values matches the Teams docs list.
libraries/microsoft-agents-activity/microsoft_agents/activity/entity/ai_entity.py Reorders enum entries and updates docstring to explicitly reference the Teams “Add citations” documentation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Need to update the AI Citations Image names to pick up current list of known image sources

4 participants