Fix documentation for the API and Websockets #2

New Issue

2026-02-16T12:28:56-05:00

yindo commented

2026-02-16 12:28:56 -05:00

Originally created by @Hunter2809 on GitHub (Nov 11, 2021).

The other status codes aren't documented, which can be there in case a request fails, like if we try to send a message to a channel where we don't have permissions.

Originally created by @Hunter2809 on GitHub (Nov 11, 2021). The other status codes aren't documented, which *can* be there in case a request fails, like if we try to send a message to a channel where we don't have permissions.

yindo added the improvement label 2026-02-16 12:28:56 -05:00

yindo closed this issue

2026-02-16 12:28:56 -05:00

yindo commented

2026-02-16 12:28:56 -05:00

@Hunter2809 commented on GitHub (Nov 11, 2021):

Also, in the Query Node endpoint, the registration key is not present. This is the JSON which I got from that endpoint

{
	"revolt":"0.5.3-alpha.8",
	"features":{
		"captcha":{
			"enabled":true,
			"key":"3daae85e-09ab-4ff6-9f24-e8f4f335e433"
		},
		"email":true,
		"invite_only":true,
		"autumn":{
			"enabled":true,
			"url":"https://autumn.revolt.chat"
		},
		"january":{
			"enabled":true,
			"url":"https://jan.revolt.chat"
		},
		"voso":{
			"enabled":true,
			"url":"https://vortex.revolt.chat",
			"ws":"wss://vortex.revolt.chat"
		}
	},
	"ws":"wss://ws.revolt.chat",
	"app":"https://app.revolt.chat",
	"vapid":"BJto1I_OZi8hOkMfQNQJfod2osWBqcOO7eEOqFMvCfqNhqgxqOr7URnxYKTR4N6sR3sTPywfHpEsPXhrU9zfZgg="
}

@Hunter2809 commented on GitHub (Nov 11, 2021): Also, in the `Query Node` endpoint, the `registration` key is not present. This is the JSON which I got from that endpoint ```json { "revolt":"0.5.3-alpha.8", "features":{ "captcha":{ "enabled":true, "key":"3daae85e-09ab-4ff6-9f24-e8f4f335e433" }, "email":true, "invite_only":true, "autumn":{ "enabled":true, "url":"https://autumn.revolt.chat" }, "january":{ "enabled":true, "url":"https://jan.revolt.chat" }, "voso":{ "enabled":true, "url":"https://vortex.revolt.chat", "ws":"wss://vortex.revolt.chat" } }, "ws":"wss://ws.revolt.chat", "app":"https://app.revolt.chat", "vapid":"BJto1I_OZi8hOkMfQNQJfod2osWBqcOO7eEOqFMvCfqNhqgxqOr7URnxYKTR4N6sR3sTPywfHpEsPXhrU9zfZgg=" } ```

yindo commented

2026-02-16 12:28:57 -05:00