mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-13 09:53:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add missing documentation/comments

Browse source
This commit is contained in:
Remi Reuvekamp 2017-11-19 19:41:48 +01:00
parent 66b69a43b5
commit b1c613f49e
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/github.com/matrix-org/dendrite/roomserver/api/query.go
View file

@ -156,13 +156,14 @@ type QueryServerAllowedToSeeEventResponse struct {
// QueryReserveRoomIDRequest is a request to QueryServerAllowedToSeeEvent // QueryReserveRoomIDRequest is a request to QueryServerAllowedToSeeEvent
type QueryReserveRoomIDRequest struct { type QueryReserveRoomIDRequest struct {
// TODO: Docs // The room ID to check and reserve.
RoomID string `json:"room_id"` RoomID string `json:"room_id"`
} }
// QueryReserveRoomIDResponse is a response to QueryServerAllowedToSeeEvent // QueryReserveRoomIDResponse is a response to QueryServerAllowedToSeeEvent
type QueryReserveRoomIDResponse struct { type QueryReserveRoomIDResponse struct {
// TODO: Docs // Whether the room ID has been reserved.
// False means that the room ID is already is use, or already reserved.
Success bool `json:"success"` Success bool `json:"success"`
} }
@ -331,7 +332,7 @@ func (h *httpRoomserverQueryAPI) QueryServerAllowedToSeeEvent(
return postJSON(ctx, span, h.httpClient, apiURL, request, response) return postJSON(ctx, span, h.httpClient, apiURL, request, response)
} }
// TODO: Docs // QueryReserveRoomID implements RoomserverQueryAPI
func (h *httpRoomserverQueryAPI) QueryReserveRoomID( func (h *httpRoomserverQueryAPI) QueryReserveRoomID(
ctx context.Context, ctx context.Context,
request *QueryReserveRoomIDRequest, request *QueryReserveRoomIDRequest,