nitrado / NitrAPI

Nitrado RESTful API
https://doc.nitrado.net/
MIT License
22 stars 9 forks source link

docs out of date / incorrect #13

Closed cainthebest closed 2 years ago

cainthebest commented 2 years ago

I have been writing a strongly typed wrapper for this API and have noticed that there are responses that are undocumented / incorrect.

Example:

curl https://api.nitrado.net/maintenance

Documented response:

HTTP/1.1 200 OK
{
  "status": "success",
  "maintenance": {
    "cloud_backend": false,
    "domain_backend": false
  }
}

Actual response:

HTTP/1.1 200 OK
{
    "status": "success",
    "data": {
        "maintenance": {
            "cloud_backend": false,
            "domain_backend": false,
            "dns_backend": false,
            "pmacct_backend": false
        }
    }
}

I see that your welcome to third party packages but how is this possible without having to try every route and write from that like I am currently lol. I know that nitrado wouldn't open source there API but then only devs from nitrado that know the API can keep packages up to date etc, as the docs are not up to date with the API leading to only supported SDKs working fully.

NitradoTimo commented 2 years ago

fixed, thx for the hint