search

PowerDNS / pdns

PowerDNS Authoritative, PowerDNS Recursor, dnsdist
https://www.powerdns.com/
GNU General Public License v2.0
3.67k stars 907 forks source link

auth API swagger: inconsistencies and missing descriptions #10034

Open Habbie opened 3 years ago

Habbie commented 3 years ago

https://doc.powerdns.com/authoritative/http-api/zone.html#zone this object has a description.

https://doc.powerdns.com/authoritative/http-api/server.html#server this object does not.

https://doc.powerdns.com/authoritative/http-api/zone.html#get--servers-server_id-zones this has a sentence describing the action (with a missing period at the end)

https://doc.powerdns.com/authoritative/http-api/zone.html#get--servers-server_id-zones-zone_id this has a sentence somewhat describing an object.

It would be great if all objects had descriptions, and all actions had explanations that described their actions.

Habbie commented 3 years ago

The swagger file is at https://github.com/PowerDNS/pdns/blob/master/docs/http-api/swagger/authoritative-api-swagger.yaml