Skip to content

Commit 8bff691

Browse files
feat: update docs
1 parent 83d463f commit 8bff691

File tree

5 files changed

+50
-45
lines changed

5 files changed

+50
-45
lines changed

content/docs/protocol.auth.v1.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Fields
7373

7474
| Name | Type |
7575
| ---- | ---- |
76-
| token | `string` |
76+
| token | [protocol.harmonytypes.v1.Token]({{< ref "protocol.harmonytypes.v1.md" >}}#token) |
7777
| nonce | `string` |
7878

7979
### KeyReply
@@ -90,9 +90,20 @@ Fields
9090

9191
| Name | Type |
9292
| ---- | ---- |
93-
| auth_token | `string` |
93+
| auth_token | [protocol.harmonytypes.v1.Token]({{< ref "protocol.harmonytypes.v1.md" >}}#token) |
9494
| domain | `string` |
9595

96+
### TokenData
97+
98+
Fields
99+
100+
| Name | Type |
101+
| ---- | ---- |
102+
| user_id | `uint64` |
103+
| target | `string` |
104+
| username | `string` |
105+
| avatar | `string` |
106+
96107
### AuthStep.Choice
97108

98109
Fields

content/docs/protocol.chat.v1.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -244,38 +244,6 @@ Fields
244244
| ---- | ---- |
245245
| guild_id | `uint64` |
246246

247-
### AddGuildToGuildListRequest
248-
249-
Fields
250-
251-
| Name | Type |
252-
| ---- | ---- |
253-
| guild_id | `uint64` |
254-
| homeserver | `string` |
255-
256-
### AddGuildToGuildListResponse
257-
258-
Fields
259-
260-
| Name | Type |
261-
| ---- | ---- |
262-
263-
### RemoveGuildFromGuildListRequest
264-
265-
Fields
266-
267-
| Name | Type |
268-
| ---- | ---- |
269-
| guild_id | `uint64` |
270-
| homeserver | `string` |
271-
272-
### RemoveGuildFromGuildListResponse
273-
274-
Fields
275-
276-
| Name | Type |
277-
| ---- | ---- |
278-
279247
### BanUserRequest
280248

281249
Fields
@@ -1027,8 +995,6 @@ Fields
1027995
|CreateChannel|[protocol.chat.v1.CreateChannelRequest](#createchannelrequest)|[protocol.chat.v1.CreateChannelResponse](#createchannelresponse)|
1028996
|CreateEmotePack|[protocol.chat.v1.CreateEmotePackRequest](#createemotepackrequest)|[protocol.chat.v1.CreateEmotePackResponse](#createemotepackresponse)|
1029997
|GetGuildList|[protocol.chat.v1.GetGuildListRequest](#getguildlistrequest)|[protocol.chat.v1.GetGuildListResponse](#getguildlistresponse)|
1030-
|AddGuildToGuildList|[protocol.chat.v1.AddGuildToGuildListRequest](#addguildtoguildlistrequest)|[protocol.chat.v1.AddGuildToGuildListResponse](#addguildtoguildlistresponse)|
1031-
|RemoveGuildFromGuildList|[protocol.chat.v1.RemoveGuildFromGuildListRequest](#removeguildfromguildlistrequest)|[protocol.chat.v1.RemoveGuildFromGuildListResponse](#removeguildfromguildlistresponse)|
1032998
|GetGuild|[protocol.chat.v1.GetGuildRequest](#getguildrequest)|[protocol.chat.v1.GetGuildResponse](#getguildresponse)|
1033999
|GetGuildInvites|[protocol.chat.v1.GetGuildInvitesRequest](#getguildinvitesrequest)|[protocol.chat.v1.GetGuildInvitesResponse](#getguildinvitesresponse)|
10341000
|GetGuildMembers|[protocol.chat.v1.GetGuildMembersRequest](#getguildmembersrequest)|[protocol.chat.v1.GetGuildMembersResponse](#getguildmembersresponse)|

content/docs/protocol.harmonytypes.v1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,15 @@ Fields
158158
| human_message | `string` |
159159
| more_details | `bytes` |
160160

161+
### Token
162+
163+
Fields
164+
165+
| Name | Type |
166+
| ---- | ---- |
167+
| sig | `bytes` |
168+
| data | `bytes` |
169+
161170
### Action.Button
162171

163172
Fields

content/docs/protocol.sync.v1.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,49 @@ title: "Reference: protocol.sync.v1"
33
---
44
## Message Types
55

6-
### SyncRequest
6+
### AuthData
77

88
Fields
99

1010
| Name | Type |
1111
| ---- | ---- |
12-
| token | `string` |
1312
| host | `string` |
13+
| time | `uint64` |
1414

15-
### PostBoxEvent
15+
### EventQueue
1616

1717
Fields
1818

1919
| Name | Type |
2020
| ---- | ---- |
21-
| event | [google.protobuf.Any]({{< ref "google.protobuf.md" >}}#any) |
21+
| events | [protocol.sync.v1.Event](#event) |
2222

23-
### PostEventRequest
23+
### Event
2424

2525
Fields
2626

2727
| Name | Type |
2828
| ---- | ---- |
29-
| sync_request | [protocol.sync.v1.SyncRequest](#syncrequest) |
30-
| event | [protocol.sync.v1.PostBoxEvent](#postboxevent) |
29+
| user_removed_from_guild | [protocol.sync.v1.Event.UserRemovedFromGuild](#event-userremovedfromguild) |
30+
| user_added_to_guild | [protocol.sync.v1.Event.UserAddedToGuild](#event-useraddedtoguild) |
31+
32+
### Event.UserRemovedFromGuild
33+
34+
Fields
35+
36+
| Name | Type |
37+
| ---- | ---- |
38+
| user_id | `uint64` |
39+
| guild_id | `uint64` |
40+
41+
### Event.UserAddedToGuild
42+
43+
Fields
44+
45+
| Name | Type |
46+
| ---- | ---- |
47+
| user_id | `uint64` |
48+
| guild_id | `uint64` |
3149

3250
## Services
3351

@@ -37,7 +55,8 @@ Fields
3755

3856
| Name | Request | Response |
3957
| ---- | ------- | -------- |
40-
|PostEvent|[protocol.sync.v1.PostEventRequest](#posteventrequest)|[google.protobuf.Empty]({{< ref "google.protobuf.md" >}}#empty)|
58+
|Pull|[google.protobuf.Empty]({{< ref "google.protobuf.md" >}}#empty)|[protocol.sync.v1.EventQueue](#eventqueue)|
59+
|Push|[protocol.sync.v1.Event](#event)|[google.protobuf.Empty]({{< ref "google.protobuf.md" >}}#empty)|
4160

4261
#### Streaming Methods
4362

0 commit comments

Comments
 (0)