From b1c613f49efe2ae5e8c00beb0d673455af3f4f3f Mon Sep 17 00:00:00 2001 From: Remi Reuvekamp Date: Sun, 19 Nov 2017 19:41:48 +0100 Subject: [PATCH] Add missing documentation/comments --- src/github.com/matrix-org/dendrite/roomserver/api/query.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/github.com/matrix-org/dendrite/roomserver/api/query.go b/src/github.com/matrix-org/dendrite/roomserver/api/query.go index 578cfe444..a4b495120 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/api/query.go +++ b/src/github.com/matrix-org/dendrite/roomserver/api/query.go @@ -156,13 +156,14 @@ type QueryServerAllowedToSeeEventResponse struct { // QueryReserveRoomIDRequest is a request to QueryServerAllowedToSeeEvent type QueryReserveRoomIDRequest struct { - // TODO: Docs + // The room ID to check and reserve. RoomID string `json:"room_id"` } // QueryReserveRoomIDResponse is a response to QueryServerAllowedToSeeEvent 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"` } @@ -331,7 +332,7 @@ func (h *httpRoomserverQueryAPI) QueryServerAllowedToSeeEvent( return postJSON(ctx, span, h.httpClient, apiURL, request, response) } -// TODO: Docs +// QueryReserveRoomID implements RoomserverQueryAPI func (h *httpRoomserverQueryAPI) QueryReserveRoomID( ctx context.Context, request *QueryReserveRoomIDRequest,