Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 200 additions & 0 deletions teams-toolkit/teamsapptesttool-config/0.1.1/config.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
{
"$id": "https://aka.ms/teams-app-test-tool-config/0.1.1/config.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ConfigFile",
"type": "object",
"required": [
"version",
"tenantId",
"bot",
"currentUser",
"users",
"personalChat",
"groupChat",
"team"
],
"additionalProperties": false,
"description": "The config file is for customization of Teams context information like chats, teams and users. All the data is mockup data only for testing various Bot Framework APIs (or botbuilder SDK methods like TeamsInfo.getTeamMembers())",
"properties": {
"version": {
"type": "string",
"enum": ["0.1.1"],
"description": "The config file version"
},
"tenantId": {
"type": "string",
"description": "The tenant's ID. This only affects user information retrieved by Bot Framework APIs (for example, TeamsInfo.getTeamMembers())"
},
"bot": {
"type": "object",
"description": "The bot app information. Can be retrieved from activity payload sent to bot message endpoint",
"required": ["id", "name"],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The bot ID"
},
"name": {
"type": "string",
"maxLength": 42,
"description": "The bot display name"
},
"agenticUserId": {
"type": "string",
"description": "The agentic user ID for the bot"
},
"agenticAppId": {
"type": "string",
"description": "The agentic app ID for the bot"
},
"tenantId": {
"type": "string",
"description": "The tenant ID for the bot"
},
"role": {
"type": "string",
"enum": ["user", "bot", "agenticUser"],
"description": "The role of the bot"
}
}
},
"currentUser": {
"$ref": "#/$defs/User",
"description": "Current user"
},
"users": {
"type": "array",
"description": "Users in the tenant. By default, these users are all in the group chat and the team",
"items": {
"$ref": "#/$defs/User"
},
"minItems": 5,
"maxItems": 5
},
"personalChat": {
"type": "object",
"description": "Personal chat with bot. This chat only contains current user and bot",
"required": ["id"],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Personal chat conversation ID. Can be used to send custom activity to this personal chat"
}
}
},
"groupChat": {
"type": "object",
"description": "Group chat information. Currently only support one group chat and contains current user and all the users specified in \"users\" property",
"required": ["id", "name"],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Group chat conversation ID. Can be used to send custom activty to this group chat"
},
"name": {
"type": "string",
"description": "Group chat display name",
"maxLength": 256
}
}
},
"team": {
"type": "object",
"description": "The team information. Currently only support a single team. Can be retrieved by TeamsInfo.getTeamDetails() in botbuilder SDK",
"required": ["id", "name", "aadGroupId", "channels"],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Team conversation ID. Can be used to send custom activity to the General channel of this team"
},
"name": {
"type": "string",
"description": "Team display name",
"maxLength": 256
},
"aadGroupId": {
"type": "string",
"description": "Azure Active Directory (AAD) group ID for the team."
},
"channels": {
"type": "array",
"description": "Channels information in the Team. Currently only support one channel in addition to the General channel. Can be retrieved by TeamsInfo.getTeamChannels() in botbuilder SDK. A team always has a General channel. And the General channel conversation ID is the same as the Team ID",
"maxItems": 1,
"items": {
"$ref": "#/$defs/Channel"
}
}
}
}
},
"$defs": {
"User": {
"type": "object",
"description": "User information. Affects the TeamsChannelAccount object returned from TeamsInfo.getMember(), TeamsInfo.getTeamMembers(), TeamsInfo.getPagedMembers(), etc. [asdf](https://www.google.com)",
"required": [
"id",
"name",
"userPrincipleName",
"aadObjectId",
"givenName",
"surname",
"email"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "User ID. This is the channel id for the user or bot on this Bot Framework channel"
},
"name": {
"type": "string",
"maxLength": 256,
"description": "Display friendly name"
},
"userPrincipleName": {
"type": "string",
"description": "User principle name"
},
"aadObjectId": {
"type": "string",
"description": "This account's Azure Active Directory object ID"
},
"givenName": {
"type": "string",
"maxLength": 256,
"description": "Given name"
},
"surname": {
"type": "string",
"maxLength": 256,
"description": "Surname"
},
"email": {
"type": "string",
"description": "User email"
}
}
},
"Channel": {
"type": "object",
"description": "Channel information",
"required": ["id", "name"],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Channel conversation ID. Can be used to send custom activity to this channel"
},
"name": {
"type": "string",
"maxLength": 256,
"description": "Channel display name"
}
}
}
}
}
21 changes: 21 additions & 0 deletions teams/vDevPreview/MicrosoftTeams.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2566,6 +2566,13 @@
"items": {
"$ref": "#/definitions/extensionRibbonsCustomMobileGroupItem"
}
},
"keytip": {
"type": "string",
"description": "KeyTip shortcut for keyboard navigation (1-3 uppercase alphanumeric characters)",
"minLength": 1,
"maxLength": 3,
"pattern": "^[A-Z0-9]+$"
}
},
"dependencies": {
Expand Down Expand Up @@ -2747,6 +2754,13 @@
"items": {
"$ref": "#/definitions/extensionCommonCustomControlMenuItem"
}
},
"keytip": {
"type": "string",
"description": "KeyTip shortcut for keyboard navigation (1-3 uppercase alphanumeric characters)",
"minLength": 1,
"maxLength": 3,
"pattern": "^[A-Z0-9]+$"
}
},
"required": [
Expand Down Expand Up @@ -2829,6 +2843,13 @@
"overriddenByRibbonApi": {
"type": "boolean",
"default": "false"
},
"keytip": {
"type": "string",
"description": "KeyTip shortcut for keyboard navigation (1-3 uppercase alphanumeric characters)",
"minLength": 1,
"maxLength": 3,
"pattern": "^[A-Z0-9]+$"
}
},
"additionalProperties": false,
Expand Down