This repository has been archived by the owner on Nov 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add info on APIs to hooks & add missing VSP fields to spec
- Loading branch information
Showing
4 changed files
with
45 additions
and
12 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,6 +44,17 @@ Follow this schema for the user data in your apps: | |
"description": "URL to a user avatar that you can display in the UI", | ||
"type": "string" | ||
}, | ||
"type": { | ||
"description": "Type of the user", | ||
"type": "string", | ||
"examples": ["default", "admin", "moderator"], | ||
"default": "default" | ||
}, | ||
"status": { | ||
"description": "Status of the user", | ||
"type": "string", | ||
"examples": ["default", "deleted"] | ||
}, | ||
"custom": { | ||
"description": "Any additional payload information", | ||
"type": "object", | ||
|
@@ -63,7 +74,7 @@ Follow this schema for the user data in your apps: | |
"type": "string" | ||
} | ||
}, | ||
"required": ["id"] | ||
"required": ["id", "type"] | ||
} | ||
``` | ||
|
||
|
@@ -76,6 +87,8 @@ Example: | |
"email": "[email protected]", | ||
"externalId": "some-external-user-id", | ||
"profileUrl": "https://randomuser.me/api/portraits/men/1.jpg", | ||
"type": "default", | ||
"status": "default", | ||
"custom": { | ||
"description": "Office Assistant" | ||
}, | ||
|
@@ -93,6 +106,7 @@ Follow this schema for the channel data in your apps: | |
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"title": "Channel", | ||
"description": "Channel in the chat application", | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"description": "Unique identifier for a channel", | ||
|
@@ -106,6 +120,17 @@ Follow this schema for the channel data in your apps: | |
"description": "Description of the channel that you can display in the UI", | ||
"type": "string" | ||
}, | ||
"type": { | ||
"description": "Type of the channel", | ||
"type": "string", | ||
"examples": ["default", "group", "direct"], | ||
"default": "default" | ||
}, | ||
"status": { | ||
"description": "Status of the channel", | ||
"type": "string", | ||
"examples": ["default", "deleted"] | ||
}, | ||
"custom": { | ||
"description": "Any additional payload information", | ||
"type": "object", | ||
|
@@ -136,6 +161,8 @@ Example: | |
"id": "some-channel-id", | ||
"name": "Off-topic", | ||
"description": "Off-topic channel for random chatter and fun", | ||
"type": "default", | ||
"status": "default", | ||
"custom": { | ||
"profileUrl": "https://www.gravatar.com/avatar/149e60f311749f2a7c6515f7b34?s=256&d=identicon" | ||
}, | ||
|