Skip to content

消息事件格式与字段略混乱 #75

Open
@ForteScarlet

Description

@ForteScarlet

文档的具体地址?

事件结构/格式说明:https://developer.kaiheila.cn/doc/event/event-introduction
消息相关事件列表:https://developer.kaiheila.cn/doc/event/message

你认为有问题的文档内容

事件结构/格式说明 中的 extra 说明中提到,extra字段分为两种可能:一个是 type == 255 的 系统消息,其格式是千变万化的,一个是其他可能,就是 “消息事件”,从文档中来看,消息事件的 extra 似乎并没有可变的点,也没有提到是否所有事件都一致

然后到 消息相关事件列表 文档中,可以看到,实际上 type != 255 的事件的 extra 字段数据之间依然有很大差距,例如 文件消息 中,出现了 attachments 字段,且该字段下的数据格式不明确(只能从示例json中看到一些字段,但是无法确定这些字段是必然存在的、还是可能出现变化的);并且 文件消息 的字段示例中还少了很多 事件结构/格式说明 中提到的字段(例如 channel_name

然后,再看到下面的 KMarkdown消息Card消息 中,extra 数据中又出现了新的字段 kmarkdown 以及一些未标注含义的字段(例如 nav_channels

然后我发现 事件结构/格式说明 中说明的 extra 字段元素似乎并非是所有事件之间的 最小范围 的通用元素,且不同事件存在 增加 / 减少 字段内容的可能。

你期望的结果?

希望能够明确事件的通用内容(例如那些字段必然是每个事件都有的),以及对于事件中出现的额外内容(例如 文件消息 中的附件字段 attachments )进行较为细致的说明(包括每个字段的类型、是否必然存在等等)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions