feat: add server field to room details in API documentation
This commit is contained in:
18
API.md
18
API.md
@@ -179,17 +179,30 @@ Get a list of available rooms/channels.
|
|||||||
{
|
{
|
||||||
"roomId": "!abc123:matrix.org",
|
"roomId": "!abc123:matrix.org",
|
||||||
"name": "General",
|
"name": "General",
|
||||||
"isDirect": false
|
"server": "matrix.org",
|
||||||
|
"isDirect": false,
|
||||||
|
"avatar": null
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"roomId": "!def456:matrix.org",
|
"roomId": "!def456:matrix.org",
|
||||||
"name": "Random",
|
"name": "Random",
|
||||||
"isDirect": false
|
"server": "matrix.org",
|
||||||
|
"isDirect": false,
|
||||||
|
"avatar": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"roomId": "!xyz789:example.com",
|
||||||
|
"name": "General",
|
||||||
|
"server": "example.com",
|
||||||
|
"isDirect": false,
|
||||||
|
"avatar": null
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note**: The `server` field helps distinguish between rooms with the same name on different servers.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Send Message
|
### Send Message
|
||||||
@@ -258,6 +271,7 @@ Get information about the currently active room.
|
|||||||
"data": {
|
"data": {
|
||||||
"roomId": "!abc123:matrix.org",
|
"roomId": "!abc123:matrix.org",
|
||||||
"name": "General",
|
"name": "General",
|
||||||
|
"server": "matrix.org",
|
||||||
"avatar": "mxc://matrix.org/abc123",
|
"avatar": "mxc://matrix.org/abc123",
|
||||||
"isDirect": false
|
"isDirect": false
|
||||||
}
|
}
|
||||||
|
|||||||
2
cinny
2
cinny
Submodule cinny updated: ef55d1583f...f00e20b1ac
Reference in New Issue
Block a user