revoltchat / api

Typescript typings and OpenAPI v3 generator for the Revolt API.
https://developers.revolt.chat/api/
MIT License
37 stars 25 forks source link

Fix documentation for the API and Websockets #9

Closed Hunter2809 closed 2 years ago

Hunter2809 commented 3 years ago

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.

Hunter2809 commented 3 years ago

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="
}
insertish commented 2 years ago

API is now auto-generated, closing issue.